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