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