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