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