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