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