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 cache:
 202   previews:
 203     size: 500 # Max number of previews you want to cache
 204   captions:
 205     size: 500 # Max number of video captions/subtitles you want to cache
 206   torrents:
 207     size: 500 # Max number of video torrents you want to cache
 208
 209 admin:
 210   # Used to generate the root user at first startup
 211   # And to receive emails from the contact form
 212   email: 'admin@example.com'
 213
 214 contact_form:
 215   enabled: true
 216
 217 signup:
 218   enabled: false
 219   limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
 220   requires_email_verification: false
 221   filters:
 222     cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
 223       whitelist: []
 224       blacklist: []
 225
 226 user:
 227   # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
 228   # -1 == unlimited
 229   video_quota: -1
 230   video_quota_daily: -1
 231
 232 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
 233 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
 234 # Please, do not disable transcoding since many uploaded videos will not work
 235 transcoding:
 236   enabled: true
 237
 238   # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
 239   allow_additional_extensions: true
 240
 241   # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
 242   allow_audio_files: true
 243
 244   # Amount of threads used by ffmpeg for 1 transcoding job
 245   threads: 1
 246   # Amount of transcoding jobs to execute in parallel
 247   concurrency: 1
 248
 249   # Choose the transcoding profile
 250   # New profiles can be added by plugins
 251   # Available in core PeerTube: 'default'
 252   profile: 'default'
 253
 254   resolutions: # Only created if the original video has a higher resolution, uses more storage!
 255     0p: false # audio-only (creates mp4 without video stream, always created when enabled)
 256     240p: false
 257     360p: false
 258     480p: false
 259     720p: false
 260     1080p: false
 261     1440p: false
 262     2160p: false
 263
 264   # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
 265   # If you also enabled the hls format, it will multiply videos storage by 2
 266   # If disabled, breaks federation with PeerTube instances < 2.1
 267   webtorrent:
 268     enabled: true
 269
 270   # /!\ Requires ffmpeg >= 4.1
 271   # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
 272   #     * Resolution change is smoother
 273   #     * Faster playback in particular with long videos
 274   #     * More stable playback (less bugs/infinite loading)
 275   # If you also enabled the webtorrent format, it will multiply videos storage by 2
 276   hls:
 277     enabled: false
 278
 279 live:
 280   enabled: false
 281
 282   # Limit lives duration
 283   # -1 == unlimited
 284   max_duration: -1 # For example: '5 hours'
 285
 286   # Limit max number of live videos created on your instance
 287   # -1 == unlimited
 288   max_instance_lives: 20
 289
 290   # Limit max number of live videos created by a user on your instance
 291   # -1 == unlimited
 292   max_user_lives: 3
 293
 294   # Allow your users to save a replay of their live
 295   # PeerTube will transcode segments in a video file
 296   # If the user daily/total quota is reached, PeerTube will stop the live
 297   # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
 298   allow_replay: true
 299
 300   # Your firewall should accept traffic from this port in TCP if you enable live
 301   rtmp:
 302     port: 1935
 303
 304   # Allow to transcode the live streaming in multiple live resolutions
 305   transcoding:
 306     enabled: true
 307     threads: 2
 308
 309     # Choose the transcoding profile
 310     # New profiles can be added by plugins
 311     # Available in core PeerTube: 'default'
 312     profile: 'default'
 313
 314     resolutions:
 315       240p: false
 316       360p: false
 317       480p: false
 318       720p: false
 319       1080p: false
 320       1440p: false
 321       2160p: false
 322
 323 import:
 324   # Add ability for your users to import remote videos (from YouTube, torrent...)
 325   videos:
 326     # Amount of import jobs to execute in parallel
 327     concurrency: 1
 328
 329     http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
 330       enabled: false
 331
 332       # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
 333       force_ipv4: false
 334
 335       # You can use an HTTP/HTTPS/SOCKS proxy with youtube-dl
 336       proxy:
 337         enabled: false
 338         url: ""
 339     torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
 340       enabled: false
 341
 342 auto_blacklist:
 343   # New videos automatically blacklisted so moderators can review before publishing
 344   videos:
 345     of_users:
 346       enabled: false
 347
 348 # Instance settings
 349 instance:
 350   name: 'PeerTube'
 351   short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
 352   description: 'Welcome to this PeerTube instance!' # Support markdown
 353   terms: 'No terms for now.' # Support markdown
 354   code_of_conduct: '' # Supports markdown
 355
 356   # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
 357   moderation_information: '' # Supports markdown
 358
 359   # Why did you create this instance?
 360   creation_reason: '' # Supports Markdown
 361
 362   # Who is behind the instance? A single person? A non profit?
 363   administrator: '' # Supports Markdown
 364
 365   # How long do you plan to maintain this instance?
 366   maintenance_lifetime: '' # Supports Markdown
 367
 368   # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
 369   business_model: '' # Supports Markdown
 370
 371   # If you want to explain on what type of hardware your PeerTube instance runs
 372   # Example: "2 vCore, 2GB RAM..."
 373   hardware_information: '' # Supports Markdown
 374
 375   # What are the main languages of your instance? To interact with your users for example
 376   # Uncomment or add the languages you want
 377   # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
 378   languages:
 379 #    - en
 380 #    - es
 381 #    - fr
 382
 383   # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
 384   # Uncomment or add the category ids you want
 385   # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
 386   categories:
 387 #    - 1  # Music
 388 #    - 2  # Films
 389 #    - 3  # Vehicles
 390 #    - 4  # Art
 391 #    - 5  # Sports
 392 #    - 6  # Travels
 393 #    - 7  # Gaming
 394 #    - 8  # People
 395 #    - 9  # Comedy
 396 #    - 10 # Entertainment
 397 #    - 11 # News & Politics
 398 #    - 12 # How To
 399 #    - 13 # Education
 400 #    - 14 # Activism
 401 #    - 15 # Science & Technology
 402 #    - 16 # Animals
 403 #    - 17 # Kids
 404 #    - 18 # Food
 405
 406   default_client_route: '/videos/trending'
 407
 408   # Whether or not the instance is dedicated to NSFW content
 409   # Enabling it will allow other administrators to know that you are mainly federating sensitive content
 410   # Moreover, the NSFW checkbox on video upload will be automatically checked by default
 411   is_nsfw: false
 412   # By default, "do_not_list" or "blur" or "display" NSFW videos
 413   # Could be overridden per user with a setting
 414   default_nsfw_policy: 'do_not_list'
 415
 416   customizations:
 417     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
 418     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
 419   # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
 420   robots: |
 421     User-agent: *
 422     Disallow:
 423   # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
 424   securitytxt:
 425     "# 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:"
 426
 427 services:
 428   # Cards configuration to format video in Twitter
 429   twitter:
 430     username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
 431     # If true, a video player will be embedded in the Twitter feed on PeerTube video share
 432     # If false, we use an image link card that will redirect on your PeerTube instance
 433     # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
 434     whitelisted: false
 435
 436 followers:
 437   instance:
 438     # Allow or not other instances to follow yours
 439     enabled: true
 440     # Whether or not an administrator must manually validate a new follower
 441     manual_approval: false
 442
 443 followings:
 444   instance:
 445     # If you want to automatically follow back new instance followers
 446     # If this option is enabled, use the mute feature instead of deleting followings
 447     # /!\ Don't enable this if you don't have a reactive moderation team /!\
 448     auto_follow_back:
 449       enabled: false
 450
 451     # If you want to automatically follow instances of the public index
 452     # If this option is enabled, use the mute feature instead of deleting followings
 453     # /!\ Don't enable this if you don't have a reactive moderation team /!\
 454     auto_follow_index:
 455       enabled: false
 456       # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
 457       index_url: ''
 458
 459 theme:
 460   default: 'default'
 461
 462 broadcast_message:
 463   enabled: false
 464   message: '' # Support markdown
 465   level: 'info' # 'info' | 'warning' | 'error'
 466   dismissable: false
 467
 468 search:
 469   # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
 470   # If enabled, the associated group will be able to "escape" from the instance follows
 471   # That means they will be able to follow channels, watch videos, list videos of non followed instances
 472   remote_uri:
 473     users: true
 474     anonymous: false
 475
 476   # Use a third party index instead of your local index, only for search results
 477   # Useful to discover content outside of your instance
 478   # If you enable search_index, you must enable remote_uri search for users
 479   # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
 480   # instead of loading the video locally
 481   search_index:
 482     enabled: false
 483     # URL of the search index, that should use the same search API and routes
 484     # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
 485     # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
 486     # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
 487     url: ''
 488     # You can disable local search, so users only use the search index
 489     disable_local_search: false
 490     # If you did not disable local search, you can decide to use the search index by default
 491     is_default_search: false