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