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