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