config/default.yaml

   1 # /!\ YOU SHOULD NOT UPDATE THIS FILE, USE production.yaml instead /!\ #
   2
   3 listen:
   4   hostname: '127.0.0.1'
   5   port: 9000
   6
   7 # Correspond to your reverse proxy server_name/listen configuration (i.e., your public PeerTube instance URL)
   8 webserver:
   9   https: false
  10   hostname: 'localhost'
  11   port: 9000
  12
  13 rates_limit:
  14   api:
  15     # 50 attempts in 10 seconds
  16     window: 10 seconds
  17     max: 50
  18   login:
  19     # 15 attempts in 5 min
  20     window: 5 minutes
  21     max: 15
  22   signup:
  23     # 2 attempts in 5 min (only succeeded attempts are taken into account)
  24     window: 5 minutes
  25     max: 2
  26   ask_send_email:
  27     # 3 attempts in 5 min
  28     window: 5 minutes
  29     max: 3
  30
  31 # Proxies to trust to get real client IP
  32 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
  33 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
  34 trust_proxy:
  35   - 'loopback'
  36
  37 # Your database name will be database.name OR 'peertube'+database.suffix
  38 database:
  39   hostname: 'localhost'
  40   port: 5432
  41   ssl: false
  42   suffix: '_dev'
  43   username: 'peertube'
  44   password: 'peertube'
  45   pool:
  46     max: 5
  47
  48 # Redis server for short time storage
  49 # You can also specify a 'socket' path to a unix socket but first need to
  50 # comment out hostname and port
  51 redis:
  52   hostname: 'localhost'
  53   port: 6379
  54   auth: null
  55   db: 0
  56
  57 # SMTP server to send emails
  58 smtp:
  59   # smtp or sendmail
  60   transport: smtp
  61   # Path to sendmail command. Required if you use sendmail transport
  62   sendmail: null
  63   hostname: null
  64   port: 465 # If you use StartTLS: 587
  65   username: null
  66   password: null
  67   tls: true # If you use StartTLS: false
  68   disable_starttls: false
  69   ca_file: null # Used for self signed certificates
  70   from_address: 'admin@example.com'
  71
  72 email:
  73   body:
  74     signature: 'PeerTube'
  75   subject:
  76     prefix: '[PeerTube]'
  77
  78 # PeerTube client/interface configuration
  79 client:
  80   videos:
  81     miniature:
  82       # By default PeerTube client displays author username
  83       prefer_author_display_name: false
  84
  85 # From the project root directory
  86 storage:
  87   tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
  88   bin: 'storage/bin/'
  89   avatars: 'storage/avatars/'
  90   videos: 'storage/videos/'
  91   streaming_playlists: 'storage/streaming-playlists/'
  92   redundancy: 'storage/redundancy/'
  93   logs: 'storage/logs/'
  94   previews: 'storage/previews/'
  95   thumbnails: 'storage/thumbnails/'
  96   torrents: 'storage/torrents/'
  97   captions: 'storage/captions/'
  98   cache: 'storage/cache/'
  99   plugins: 'storage/plugins/'
 100   # Overridable client files in client/dist/assets/images:
 101   # - logo.svg
 102   # - favicon.png
 103   # - default-playlist.jpg
 104   # - default-avatar-account.png
 105   # - default-avatar-video-channel.png
 106   # - and icons/*.png (PWA)
 107   # Could contain for example assets/images/favicon.png
 108   # If the file exists, peertube will serve it
 109   # If not, peertube will fallback to the default file
 110   client_overrides: 'storage/client-overrides/'
 111
 112 object_storage:
 113   enabled: false
 114
 115   # Without protocol, will default to HTTPS
 116   endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
 117
 118   region: 'us-east-1'
 119
 120   credentials:
 121     # You can also use AWS_ACCESS_KEY_ID env variable
 122     access_key_id: ''
 123     # You can also use AWS_SECRET_ACCESS_KEY env variable
 124     secret_access_key: ''
 125
 126   # Maximum amount to upload in one request to object storage
 127   max_upload_part: 2GB
 128
 129   streaming_playlists:
 130     bucket_name: 'streaming-playlists'
 131
 132     # Allows setting all buckets to the same value but with a different prefix
 133     prefix: '' # Example: 'streaming-playlists:'
 134
 135     # Base url for object URL generation, scheme and host will be replaced by this URL
 136     # Useful when you want to use a CDN/external proxy
 137     base_url: '' # Example: 'https://mirror.example.com'
 138
 139   # Same settings but for webtorrent videos
 140   videos:
 141     bucket_name: 'videos'
 142     prefix: ''
 143     base_url: ''
 144
 145 log:
 146   level: 'info' # 'debug' | 'info' | 'warn' | 'error'
 147   rotation:
 148     enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
 149     max_file_size: 12MB
 150     max_files: 20
 151   anonymize_ip: false
 152   log_ping_requests: true
 153   prettify_sql: false
 154
 155 trending:
 156   videos:
 157     interval_days: 7 # Compute trending videos for the last x days
 158     algorithms:
 159       enabled:
 160         - 'best' # adaptation of Reddit's 'Best' algorithm (Hot minus History)
 161         - 'hot' # adaptation of Reddit's 'Hot' algorithm
 162         - 'most-viewed' # default, used initially by PeerTube as the trending page
 163         - 'most-liked'
 164       default: 'most-viewed'
 165
 166 # Cache remote videos on your server, to help other instances to broadcast the video
 167 # You can define multiple caches using different sizes/strategies
 168 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
 169 redundancy:
 170   videos:
 171     check_interval: '1 hour' # How often you want to check new videos to cache
 172     strategies: # Just uncomment strategies you want
 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: 'most-views' # Cache videos that have the most views
 178 #      -
 179 #        size: '10GB'
 180 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 181 #        min_lifetime: '48 hours'
 182 #        strategy: 'trending' # Cache trending videos
 183 #      -
 184 #        size: '10GB'
 185 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 186 #        min_lifetime: '48 hours'
 187 #        strategy: 'recently-added' # Cache recently added videos
 188 #        min_views: 10 # Having at least x views
 189
 190 # Other instances that duplicate your content
 191 remote_redundancy:
 192   videos:
 193     # 'nobody': Do not accept remote redundancies
 194     # 'anybody': Accept remote redundancies from anybody
 195     # 'followings': Accept redundancies from instance followings
 196     accept_from: 'anybody'
 197
 198 csp:
 199   enabled: false
 200   report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
 201   report_uri:
 202
 203 security:
 204   # Set the X-Frame-Options header to help to mitigate clickjacking attacks
 205   frameguard:
 206     enabled: true
 207
 208 tracker:
 209   # If you disable the tracker, you disable the P2P aspect of PeerTube
 210   enabled: true
 211   # Only handle requests on your videos
 212   # If you set this to false it means you have a public tracker
 213   # Then, it is possible that clients overload your instance with external torrents
 214   private: true
 215   # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
 216   reject_too_many_announces: false
 217
 218 history:
 219   videos:
 220     # If you want to limit users videos history
 221     # -1 means there is no limitations
 222     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
 223     max_age: -1
 224
 225 views:
 226   videos:
 227     # PeerTube creates a database entry every hour for each video to track views over a period of time
 228     # This is used in particular by the Trending page
 229     # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
 230     # -1 means no cleanup
 231     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
 232     remote:
 233       max_age: '30 days'
 234
 235 plugins:
 236   # The website PeerTube will ask for available PeerTube plugins and themes
 237   # This is an unmoderated plugin index, so only install plugins/themes you trust
 238   index:
 239     enabled: true
 240     check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
 241     url: 'https://packages.joinpeertube.org'
 242
 243 federation:
 244   videos:
 245     federate_unlisted: false
 246
 247     # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
 248     # It removes objects that do not exist anymore, and potentially fix their URLs
 249     # 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
 250     # We still suggest you to enable this setting even if your users will loose most of their video's likes/dislikes
 251     cleanup_remote_interactions: false
 252
 253 peertube:
 254   check_latest_version:
 255     # Check and notify admins of new PeerTube versions
 256     enabled: true
 257     # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
 258     url: 'https://joinpeertube.org/api/v1/versions.json'
 259
 260 webadmin:
 261   configuration:
 262     edition:
 263       # Set this to false if you don't want to allow config edition in the web interface by instance admins
 264       allowed: true
 265
 266 cache:
 267   previews:
 268     size: 500 # Max number of previews you want to cache
 269   captions:
 270     size: 500 # Max number of video captions/subtitles you want to cache
 271   torrents:
 272     size: 500 # Max number of video torrents you want to cache
 273
 274 admin:
 275   # Used to generate the root user at first startup
 276   # And to receive emails from the contact form
 277   email: 'admin@example.com'
 278
 279 contact_form:
 280   enabled: true
 281
 282 signup:
 283   enabled: false
 284   limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
 285   minimum_age: 16 # Used to configure the signup form
 286   requires_email_verification: false
 287   filters:
 288     cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
 289       whitelist: []
 290       blacklist: []
 291
 292 user:
 293   # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
 294   # Byte format is supported ("1GB" etc)
 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       youtube_dl_release:
 400         # Direct download URL to youtube-dl binary
 401         # Github releases API is also supported
 402         # Examples:
 403         #   * https://api.github.com/repos/ytdl-org/youtube-dl/releases
 404         #   * https://api.github.com/repos/yt-dlp/yt-dlp/releases
 405         url: 'https://yt-dl.org/downloads/latest/youtube-dl'
 406
 407         # youtube-dl binary name
 408         # yt-dlp is also supported
 409         name: 'youtube-dl'
 410
 411       # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
 412       force_ipv4: false
 413
 414     torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
 415       enabled: false
 416
 417 auto_blacklist:
 418   # New videos automatically blacklisted so moderators can review before publishing
 419   videos:
 420     of_users:
 421       enabled: false
 422
 423 # Instance settings
 424 instance:
 425   name: 'PeerTube'
 426   short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
 427   description: 'Welcome to this PeerTube instance!' # Support markdown
 428   terms: 'No terms for now.' # Support markdown
 429   code_of_conduct: '' # Supports markdown
 430
 431   # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
 432   moderation_information: '' # Supports markdown
 433
 434   # Why did you create this instance?
 435   creation_reason: '' # Supports Markdown
 436
 437   # Who is behind the instance? A single person? A non profit?
 438   administrator: '' # Supports Markdown
 439
 440   # How long do you plan to maintain this instance?
 441   maintenance_lifetime: '' # Supports Markdown
 442
 443   # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
 444   business_model: '' # Supports Markdown
 445
 446   # If you want to explain on what type of hardware your PeerTube instance runs
 447   # Example: '2 vCore, 2GB RAM...'
 448   hardware_information: '' # Supports Markdown
 449
 450   # What are the main languages of your instance? To interact with your users for example
 451   # Uncomment or add the languages you want
 452   # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
 453   languages:
 454 #    - en
 455 #    - es
 456 #    - fr
 457
 458   # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
 459   # Uncomment or add the category ids you want
 460   # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
 461   categories:
 462 #    - 1  # Music
 463 #    - 2  # Films
 464 #    - 3  # Vehicles
 465 #    - 4  # Art
 466 #    - 5  # Sports
 467 #    - 6  # Travels
 468 #    - 7  # Gaming
 469 #    - 8  # People
 470 #    - 9  # Comedy
 471 #    - 10 # Entertainment
 472 #    - 11 # News & Politics
 473 #    - 12 # How To
 474 #    - 13 # Education
 475 #    - 14 # Activism
 476 #    - 15 # Science & Technology
 477 #    - 16 # Animals
 478 #    - 17 # Kids
 479 #    - 18 # Food
 480
 481   default_client_route: '/videos/trending'
 482
 483   # Whether or not the instance is dedicated to NSFW content
 484   # Enabling it will allow other administrators to know that you are mainly federating sensitive content
 485   # Moreover, the NSFW checkbox on video upload will be automatically checked by default
 486   is_nsfw: false
 487   # By default, `do_not_list` or `blur` or `display` NSFW videos
 488   # Could be overridden per user with a setting
 489   default_nsfw_policy: 'do_not_list'
 490
 491   customizations:
 492     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
 493     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
 494   # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
 495   robots: |
 496     User-agent: *
 497     Disallow:
 498   # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
 499   securitytxt:
 500     '# 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:'
 501
 502 services:
 503   # Cards configuration to format video in Twitter
 504   twitter:
 505     username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
 506     # If true, a video player will be embedded in the Twitter feed on PeerTube video share
 507     # If false, we use an image link card that will redirect on your PeerTube instance
 508     # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
 509     whitelisted: false
 510
 511 followers:
 512   instance:
 513     # Allow or not other instances to follow yours
 514     enabled: true
 515     # Whether or not an administrator must manually validate a new follower
 516     manual_approval: false
 517
 518 followings:
 519   instance:
 520     # If you want to automatically follow back new instance followers
 521     # If this option is enabled, use the mute feature instead of deleting followings
 522     # /!\ Don't enable this if you don't have a reactive moderation team /!\
 523     auto_follow_back:
 524       enabled: false
 525
 526     # If you want to automatically follow instances of the public index
 527     # If this option is enabled, use the mute feature instead of deleting followings
 528     # /!\ Don't enable this if you don't have a reactive moderation team /!\
 529     auto_follow_index:
 530       enabled: false
 531       # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
 532       index_url: ''
 533
 534 theme:
 535   default: 'default'
 536
 537 broadcast_message:
 538   enabled: false
 539   message: '' # Support markdown
 540   level: 'info' # 'info' | 'warning' | 'error'
 541   dismissable: false
 542
 543 search:
 544   # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
 545   # If enabled, the associated group will be able to "escape" from the instance follows
 546   # That means they will be able to follow channels, watch videos, list videos of non followed instances
 547   remote_uri:
 548     users: true
 549     anonymous: false
 550
 551   # Use a third party index instead of your local index, only for search results
 552   # Useful to discover content outside of your instance
 553   # If you enable search_index, you must enable remote_uri search for users
 554   # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
 555   # instead of loading the video locally
 556   search_index:
 557     enabled: false
 558     # URL of the search index, that should use the same search API and routes
 559     # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
 560     # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
 561     # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
 562     url: ''
 563     # You can disable local search, so users only use the search index
 564     disable_local_search: false
 565     # If you did not disable local search, you can decide to use the search index by default
 566     is_default_search: false