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