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