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