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