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