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