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