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