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