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