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