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