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