config/production.yaml.example

   1 listen:
   2   hostname: 'localhost'
   3   port: 9000
   4
   5 # Correspond to your reverse proxy server_name/listen configuration (i.e., your public PeerTube instance URL)
   6 webserver:
   7   https: true
   8   hostname: 'example.com'
   9   port: 443
  10
  11 rates_limit:
  12   api:
  13     # 50 attempts in 10 seconds
  14     window: 10 seconds
  15     max: 50
  16   login:
  17     # 15 attempts in 5 min
  18     window: 5 minutes
  19     max: 15
  20   signup:
  21     # 2 attempts in 5 min (only succeeded attempts are taken into account)
  22     window: 5 minutes
  23     max: 2
  24   ask_send_email:
  25     # 3 attempts in 5 min
  26     window: 5 minutes
  27     max: 3
  28
  29 # Proxies to trust to get real client IP
  30 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
  31 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
  32 trust_proxy:
  33   - 'loopback'
  34
  35 # Your database name will be database.name OR 'peertube'+database.suffix
  36 database:
  37   hostname: 'localhost'
  38   port: 5432
  39   ssl: false
  40   suffix: '_prod'
  41   username: 'peertube'
  42   password: 'peertube'
  43   pool:
  44     max: 5
  45
  46 # Redis server for short time storage
  47 # You can also specify a 'socket' path to a unix socket but first need to
  48 # comment out hostname and port
  49 redis:
  50   hostname: 'localhost'
  51   port: 6379
  52   auth: null
  53   db: 0
  54
  55 # SMTP server to send emails
  56 smtp:
  57   # smtp or sendmail
  58   transport: smtp
  59   # Path to sendmail command. Required if you use sendmail transport
  60   sendmail: null
  61   hostname: null
  62   port: 465 # If you use StartTLS: 587
  63   username: null
  64   password: null
  65   tls: true # If you use StartTLS: false
  66   disable_starttls: false
  67   ca_file: null # Used for self signed certificates
  68   from_address: 'admin@example.com'
  69
  70 email:
  71   body:
  72     signature: 'PeerTube'
  73   subject:
  74     prefix: '[PeerTube]'
  75
  76 # Update default PeerTube values
  77 # Set by API when the field is not provided and put as default value in client
  78 defaults:
  79   # Change default values when publishing a video (upload/import/go Live)
  80   publish:
  81     download_enabled: true
  82
  83     comments_enabled: true
  84
  85     # public = 1, unlisted = 2, private = 3, internal = 4
  86     privacy: 1
  87
  88     # CC-BY = 1, CC-SA = 2, CC-ND = 3, CC-NC = 4, CC-NC-SA = 5, CC-NC-ND = 6, Public Domain = 7
  89     # You can also choose a custom licence value added by a plugin
  90     # No licence by default
  91     licence: null
  92
  93   p2p:
  94     # Enable P2P by default
  95     # Can be enabled/disabled by anonymous users and logged in users
  96     enabled: true
  97
  98 # From the project root directory
  99 storage:
 100   tmp: '/var/www/peertube/storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
 101   bin: '/var/www/peertube/storage/bin/'
 102   avatars: '/var/www/peertube/storage/avatars/'
 103   videos: '/var/www/peertube/storage/videos/'
 104   streaming_playlists: '/var/www/peertube/storage/streaming-playlists/'
 105   redundancy: '/var/www/peertube/storage/redundancy/'
 106   logs: '/var/www/peertube/storage/logs/'
 107   previews: '/var/www/peertube/storage/previews/'
 108   thumbnails: '/var/www/peertube/storage/thumbnails/'
 109   torrents: '/var/www/peertube/storage/torrents/'
 110   captions: '/var/www/peertube/storage/captions/'
 111   cache: '/var/www/peertube/storage/cache/'
 112   plugins: '/var/www/peertube/storage/plugins/'
 113   # Overridable client files in client/dist/assets/images:
 114   # - logo.svg
 115   # - favicon.png
 116   # - default-playlist.jpg
 117   # - default-avatar-account.png
 118   # - default-avatar-video-channel.png
 119   # - and icons/*.png (PWA)
 120   # Could contain for example assets/images/favicon.png
 121   # If the file exists, peertube will serve it
 122   # If not, peertube will fallback to the default file
 123   client_overrides: '/var/www/peertube/storage/client-overrides/'
 124
 125 object_storage:
 126   enabled: false
 127
 128   # Without protocol, will default to HTTPS
 129   endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
 130
 131   region: 'us-east-1'
 132
 133   credentials:
 134     # You can also use AWS_ACCESS_KEY_ID env variable
 135     access_key_id: ''
 136     # You can also use AWS_SECRET_ACCESS_KEY env variable
 137     secret_access_key: ''
 138
 139   # Maximum amount to upload in one request to object storage
 140   max_upload_part: 2GB
 141
 142   streaming_playlists:
 143     bucket_name: 'streaming-playlists'
 144
 145     # Allows setting all buckets to the same value but with a different prefix
 146     prefix: '' # Example: 'streaming-playlists:'
 147
 148     # Base url for object URL generation, scheme and host will be replaced by this URL
 149     # Useful when you want to use a CDN/external proxy
 150     base_url: '' # Example: 'https://mirror.example.com'
 151
 152   # Same settings but for webtorrent videos
 153   videos:
 154     bucket_name: 'videos'
 155     prefix: ''
 156     base_url: ''
 157
 158 log:
 159   level: 'info' # 'debug' | 'info' | 'warn' | 'error'
 160   rotation:
 161     enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
 162     max_file_size: 12MB
 163     max_files: 20
 164   anonymize_ip: false
 165   log_ping_requests: true
 166   prettify_sql: false
 167
 168 trending:
 169   videos:
 170     interval_days: 7 # Compute trending videos for the last x days
 171     algorithms:
 172       enabled:
 173         - 'best' # adaptation of Reddit's 'Best' algorithm (Hot minus History)
 174         - 'hot' # adaptation of Reddit's 'Hot' algorithm
 175         - 'most-viewed' # default, used initially by PeerTube as the trending page
 176         - 'most-liked'
 177       default: 'most-viewed'
 178
 179 # Cache remote videos on your server, to help other instances to broadcast the video
 180 # You can define multiple caches using different sizes/strategies
 181 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
 182 redundancy:
 183   videos:
 184     check_interval: '1 hour' # How often you want to check new videos to cache
 185     strategies: # Just uncomment strategies you want
 186 #      -
 187 #        size: '10GB'
 188 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 189 #        min_lifetime: '48 hours'
 190 #        strategy: 'most-views' # Cache videos that have the most views
 191 #      -
 192 #        size: '10GB'
 193 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 194 #        min_lifetime: '48 hours'
 195 #        strategy: 'trending' # Cache trending videos
 196 #      -
 197 #        size: '10GB'
 198 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 199 #        min_lifetime: '48 hours'
 200 #        strategy: 'recently-added' # Cache recently added videos
 201 #        min_views: 10 # Having at least x views
 202
 203 # Other instances that duplicate your content
 204 remote_redundancy:
 205   videos:
 206     # 'nobody': Do not accept remote redundancies
 207     # 'anybody': Accept remote redundancies from anybody
 208     # 'followings': Accept redundancies from instance followings
 209     accept_from: 'anybody'
 210
 211 csp:
 212   enabled: false
 213   report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
 214   report_uri:
 215
 216 security:
 217   # Set the X-Frame-Options header to help to mitigate clickjacking attacks
 218   frameguard:
 219     enabled: true
 220
 221 tracker:
 222   # If you disable the tracker, you disable the P2P aspect of PeerTube
 223   enabled: true
 224   # Only handle requests on your videos
 225   # If you set this to false it means you have a public tracker
 226   # Then, it is possible that clients overload your instance with external torrents
 227   private: true
 228   # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
 229   reject_too_many_announces: false
 230
 231 history:
 232   videos:
 233     # If you want to limit users videos history
 234     # -1 means there is no limitations
 235     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
 236     max_age: -1
 237
 238 views:
 239   videos:
 240     # PeerTube creates a database entry every hour for each video to track views over a period of time
 241     # This is used in particular by the Trending page
 242     # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
 243     # -1 means no cleanup
 244     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
 245     remote:
 246       max_age: '30 days'
 247
 248     # PeerTube buffers local video views before updating and federating the video
 249     local_buffer_update_interval: '30 minutes'
 250
 251     ip_view_expiration: '1 hour'
 252
 253 plugins:
 254   # The website PeerTube will ask for available PeerTube plugins and themes
 255   # This is an unmoderated plugin index, so only install plugins/themes you trust
 256   index:
 257     enabled: true
 258     check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
 259     url: 'https://packages.joinpeertube.org'
 260
 261 federation:
 262   videos:
 263     federate_unlisted: false
 264
 265     # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
 266     # It removes objects that do not exist anymore, and potentially fix their URLs
 267     cleanup_remote_interactions: true
 268
 269 peertube:
 270   check_latest_version:
 271     # Check and notify admins of new PeerTube versions
 272     enabled: true
 273     # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
 274     url: 'https://joinpeertube.org/api/v1/versions.json'
 275
 276 webadmin:
 277   configuration:
 278     edition:
 279       # Set this to false if you don't want to allow config edition in the web interface by instance admins
 280       allowed: true
 281
 282 ###############################################################################
 283 #
 284 # From this point, all the following keys can be overridden by the web interface
 285 # (local-production.json file). If you need to change some values, prefer to
 286 # use the web interface because the configuration will be automatically
 287 # reloaded without any need to restart PeerTube
 288 #
 289 # /!\ If you already have a local-production.json file, the modification of the
 290 # following keys will have no effect /!\
 291 #
 292 ###############################################################################
 293
 294 cache:
 295   previews:
 296     size: 500 # Max number of previews you want to cache
 297   captions:
 298     size: 500 # Max number of video captions/subtitles you want to cache
 299   torrents:
 300     size: 500 # Max number of video torrents you want to cache
 301
 302 admin:
 303   # Used to generate the root user at first startup
 304   # And to receive emails from the contact form
 305   email: 'admin@example.com'
 306
 307 contact_form:
 308   enabled: true
 309
 310 signup:
 311   enabled: false
 312   limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
 313   minimum_age: 16 # Used to configure the signup form
 314   requires_email_verification: false
 315   filters:
 316     cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
 317       whitelist: []
 318       blacklist: []
 319
 320 user:
 321   # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
 322   # Byte format is supported ("1GB" etc)
 323   # -1 == unlimited
 324   video_quota: -1
 325   video_quota_daily: -1
 326
 327 video_channels:
 328   max_per_user: 20 # Allows each user to create up to 20 video channels.
 329
 330 # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
 331 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions
 332 # Please, do not disable transcoding since many uploaded videos will not work
 333 transcoding:
 334   enabled: true
 335
 336   # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
 337   allow_additional_extensions: true
 338
 339   # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
 340   allow_audio_files: true
 341
 342   # Amount of threads used by ffmpeg for 1 transcoding job
 343   threads: 1
 344   # Amount of transcoding jobs to execute in parallel
 345   concurrency: 1
 346
 347   # Choose the transcoding profile
 348   # New profiles can be added by plugins
 349   # Available in core PeerTube: 'default'
 350   profile: 'default'
 351
 352   resolutions: # Only created if the original video has a higher resolution, uses more storage!
 353     0p: false # audio-only (creates mp4 without video stream, always created when enabled)
 354     144p: false
 355     240p: false
 356     360p: false
 357     480p: false
 358     720p: false
 359     1080p: false
 360     1440p: false
 361     2160p: false
 362
 363   # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
 364   # If you also enabled the hls format, it will multiply videos storage by 2
 365   # If disabled, breaks federation with PeerTube instances < 2.1
 366   webtorrent:
 367     enabled: false
 368
 369   # /!\ Requires ffmpeg >= 4.1
 370   # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
 371   #     * Resolution change is smoother
 372   #     * Faster playback in particular with long videos
 373   #     * More stable playback (less bugs/infinite loading)
 374   # If you also enabled the webtorrent format, it will multiply videos storage by 2
 375   hls:
 376     enabled: true
 377
 378 live:
 379   enabled: false
 380
 381   # Limit lives duration
 382   # -1 == unlimited
 383   max_duration: -1 # For example: '5 hours'
 384
 385   # Limit max number of live videos created on your instance
 386   # -1 == unlimited
 387   max_instance_lives: 20
 388
 389   # Limit max number of live videos created by a user on your instance
 390   # -1 == unlimited
 391   max_user_lives: 3
 392
 393   # Allow your users to save a replay of their live
 394   # PeerTube will transcode segments in a video file
 395   # If the user daily/total quota is reached, PeerTube will stop the live
 396   # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
 397   allow_replay: true
 398
 399   # Your firewall should accept traffic from this port in TCP if you enable live
 400   rtmp:
 401     enabled: true
 402     port: 1935
 403
 404   rtmps:
 405     enabled: false
 406     port: 1936
 407     # Absolute path
 408     key_file: ''
 409     # Absolute path
 410     cert_file: ''
 411
 412   # Allow to transcode the live streaming in multiple live resolutions
 413   transcoding:
 414     enabled: true
 415     threads: 2
 416
 417     # Choose the transcoding profile
 418     # New profiles can be added by plugins
 419     # Available in core PeerTube: 'default'
 420     profile: 'default'
 421
 422     resolutions:
 423       144p: false
 424       240p: false
 425       360p: false
 426       480p: false
 427       720p: false
 428       1080p: false
 429       1440p: false
 430       2160p: false
 431
 432 import:
 433   # Add ability for your users to import remote videos (from YouTube, torrent...)
 434   videos:
 435     # Amount of import jobs to execute in parallel
 436     concurrency: 1
 437
 438     http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
 439       enabled: false
 440
 441       youtube_dl_release:
 442         # Direct download URL to youtube-dl binary
 443         # Github releases API is also supported
 444         # Examples:
 445         #   * https://api.github.com/repos/ytdl-org/youtube-dl/releases
 446         #   * https://api.github.com/repos/yt-dlp/yt-dlp/releases
 447         url: 'https://yt-dl.org/downloads/latest/youtube-dl'
 448
 449         # youtube-dl binary name
 450         # yt-dlp is also supported
 451         name: 'youtube-dl'
 452
 453       # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
 454       force_ipv4: false
 455
 456     torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
 457       enabled: false
 458
 459 auto_blacklist:
 460   # New videos automatically blacklisted so moderators can review before publishing
 461   videos:
 462     of_users:
 463       enabled: false
 464
 465 # Instance settings
 466 instance:
 467   name: 'PeerTube'
 468   short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
 469   description: 'Welcome to this PeerTube instance!' # Support markdown
 470   terms: 'No terms for now.' # Support markdown
 471   code_of_conduct: '' # Supports markdown
 472
 473   # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
 474   moderation_information: '' # Supports markdown
 475
 476   # Why did you create this instance?
 477   creation_reason: '' # Supports Markdown
 478
 479   # Who is behind the instance? A single person? A non profit?
 480   administrator: '' # Supports Markdown
 481
 482   # How long do you plan to maintain this instance?
 483   maintenance_lifetime: '' # Supports Markdown
 484
 485   # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
 486   business_model: '' # Supports Markdown
 487
 488   # If you want to explain on what type of hardware your PeerTube instance runs
 489   # Example: '2 vCore, 2GB RAM...'
 490   hardware_information: '' # Supports Markdown
 491
 492   # What are the main languages of your instance? To interact with your users for example
 493   # Uncomment or add the languages you want
 494   # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
 495   languages:
 496 #    - en
 497 #    - es
 498 #    - fr
 499
 500   # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
 501   # Uncomment or add the category ids you want
 502   # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
 503   categories:
 504 #    - 1  # Music
 505 #    - 2  # Films
 506 #    - 3  # Vehicles
 507 #    - 4  # Art
 508 #    - 5  # Sports
 509 #    - 6  # Travels
 510 #    - 7  # Gaming
 511 #    - 8  # People
 512 #    - 9  # Comedy
 513 #    - 10 # Entertainment
 514 #    - 11 # News & Politics
 515 #    - 12 # How To
 516 #    - 13 # Education
 517 #    - 14 # Activism
 518 #    - 15 # Science & Technology
 519 #    - 16 # Animals
 520 #    - 17 # Kids
 521 #    - 18 # Food
 522
 523   default_client_route: '/videos/trending'
 524
 525   # Whether or not the instance is dedicated to NSFW content
 526   # Enabling it will allow other administrators to know that you are mainly federating sensitive content
 527   # Moreover, the NSFW checkbox on video upload will be automatically checked by default
 528   is_nsfw: false
 529   # By default, `do_not_list` or `blur` or `display` NSFW videos
 530   # Could be overridden per user with a setting
 531   default_nsfw_policy: 'do_not_list'
 532
 533   customizations:
 534     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
 535     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
 536   # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
 537   robots: |
 538     User-agent: *
 539     Disallow:
 540   # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
 541   securitytxt:
 542     '# If you would like to report a security issue\n# you may report it to:\nContact: https://github.com/Chocobozzz/PeerTube/blob/develop/SECURITY.md\nContact: mailto:'
 543
 544 services:
 545   # Cards configuration to format video in Twitter
 546   twitter:
 547     username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
 548     # If true, a video player will be embedded in the Twitter feed on PeerTube video share
 549     # If false, we use an image link card that will redirect on your PeerTube instance
 550     # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
 551     whitelisted: false
 552
 553 followers:
 554   instance:
 555     # Allow or not other instances to follow yours
 556     enabled: true
 557     # Whether or not an administrator must manually validate a new follower
 558     manual_approval: false
 559
 560 followings:
 561   instance:
 562     # If you want to automatically follow back new instance followers
 563     # If this option is enabled, use the mute feature instead of deleting followings
 564     # /!\ Don't enable this if you don't have a reactive moderation team /!\
 565     auto_follow_back:
 566       enabled: false
 567
 568     # If you want to automatically follow instances of the public index
 569     # If this option is enabled, use the mute feature instead of deleting followings
 570     # /!\ Don't enable this if you don't have a reactive moderation team /!\
 571     auto_follow_index:
 572       enabled: false
 573       # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
 574       index_url: ''
 575
 576 theme:
 577   default: 'default'
 578
 579 broadcast_message:
 580   enabled: false
 581   message: '' # Support markdown
 582   level: 'info' # 'info' | 'warning' | 'error'
 583   dismissable: false
 584
 585 search:
 586   # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
 587   # If enabled, the associated group will be able to "escape" from the instance follows
 588   # That means they will be able to follow channels, watch videos, list videos of non followed instances
 589   remote_uri:
 590     users: true
 591     anonymous: false
 592
 593   # Use a third party index instead of your local index, only for search results
 594   # Useful to discover content outside of your instance
 595   # If you enable search_index, you must enable remote_uri search for users
 596   # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
 597   # instead of loading the video locally
 598   search_index:
 599     enabled: false
 600     # URL of the search index, that should use the same search API and routes
 601     # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
 602     # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
 603     # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
 604     url: ''
 605     # You can disable local search, so users only use the search index
 606     disable_local_search: false
 607     # If you did not disable local search, you can decide to use the search index by default
 608     is_default_search: false
 609
 610 # PeerTube client/interface configuration
 611 client:
 612   videos:
 613     miniature:
 614       # By default PeerTube client displays author username
 615       prefer_author_display_name: false
 616
 617   menu:
 618     login:
 619       # If you enable only one external auth plugin
 620       # You can automatically redirect your users on this external platform when they click on the login button
 621       redirect_on_single_external_auth: false