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