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