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