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   login:
  14     # 15 attempts in 5 min
  15     window: 5 minutes
  16     max: 15
  17   ask_send_email:
  18     # 3 attempts in 5 min
  19     window: 5 minutes
  20     max: 3
  21
  22 # Proxies to trust to get real client IP
  23 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
  24 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
  25 trust_proxy:
  26   - 'loopback'
  27
  28 # Your database name will be "peertube"+database.suffix
  29 database:
  30   hostname: 'localhost'
  31   port: 5432
  32   suffix: '_dev'
  33   username: 'peertube'
  34   password: 'peertube'
  35   pool:
  36     max: 5
  37
  38 # You can also specify a 'socket' path to a unix socket but first need to
  39 # comment out hostname and port
  40 redis:
  41   hostname: 'localhost'
  42   port: 6379
  43   auth: null
  44   db: 0
  45
  46 smtp:
  47   hostname: null
  48   port: 465
  49   username: null
  50   password: null
  51   tls: true
  52   disable_starttls: false
  53   ca_file: null # Used for self signed certificates
  54   from_address: 'admin@example.com'
  55
  56 email:
  57   body:
  58     signature: "PeerTube"
  59   object:
  60     prefix: "[PeerTube]"
  61
  62 # From the project root directory
  63 storage:
  64   tmp: 'storage/tmp/' # Used to download data (imports etc), store uploaded files before processing...
  65   avatars: 'storage/avatars/'
  66   videos: 'storage/videos/'
  67   streaming_playlists: 'storage/streaming-playlists/'
  68   redundancy: 'storage/redundancy/'
  69   logs: 'storage/logs/'
  70   previews: 'storage/previews/'
  71   thumbnails: 'storage/thumbnails/'
  72   torrents: 'storage/torrents/'
  73   captions: 'storage/captions/'
  74   cache: 'storage/cache/'
  75
  76 log:
  77   level: 'info' # debug/info/warning/error
  78
  79 search:
  80   # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
  81   # If enabled, the associated group will be able to "escape" from the instance follows
  82   # That means they will be able to follow channels, watch videos, list videos of non followed instances
  83   remote_uri:
  84     users: true
  85     anonymous: false
  86
  87 trending:
  88   videos:
  89     interval_days: 7 # Compute trending videos for the last x days
  90
  91 # Cache remote videos on your server, to help other instances to broadcast the video
  92 # You can define multiple caches using different sizes/strategies
  93 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
  94 redundancy:
  95   videos:
  96     check_interval: '1 hour' # How often you want to check new videos to cache
  97     strategies: # Just uncomment strategies you want
  98 #      -
  99 #        size: '10GB'
 100 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 101 #        min_lifetime: '48 hours'
 102 #        strategy: 'most-views' # Cache videos that have the most views
 103 #      -
 104 #        size: '10GB'
 105 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 106 #        min_lifetime: '48 hours'
 107 #        strategy: 'trending' # Cache trending videos
 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: 'recently-added' # Cache recently added videos
 113 #        min_views: 10 # Having at least x views
 114
 115 csp:
 116   enabled: false
 117   report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
 118   report_uri:
 119
 120 tracker:
 121   # If you disable the tracker, you disable the P2P aspect of PeerTube
 122   enabled: true
 123   # Only handle requests on your videos.
 124   # If you set this to false it means you have a public tracker.
 125   # Then, it is possible that clients overload your instance with external torrents
 126   private: true
 127   # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
 128   reject_too_many_announces: false
 129
 130 history:
 131   videos:
 132     # If you want to limit users videos history
 133     # -1 means there is no limitations
 134     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
 135     max_age: -1
 136
 137 views:
 138   videos:
 139     # PeerTube creates a database entry every hour for each video to track views over a period of time
 140     # This is used in particular by the Trending page
 141     # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
 142     # -1 means no cleanup
 143     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
 144     remote:
 145       max_age: -1
 146
 147 cache:
 148   previews:
 149     size: 500 # Max number of previews you want to cache
 150   captions:
 151     size: 500 # Max number of video captions/subtitles you want to cache
 152
 153 admin:
 154   # Used to generate the root user at first startup
 155   # And to receive emails from the contact form
 156   email: 'admin@example.com'
 157
 158 contact_form:
 159   enabled: true
 160
 161 signup:
 162   enabled: false
 163   limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
 164   requires_email_verification: false
 165   filters:
 166     cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
 167       whitelist: []
 168       blacklist: []
 169
 170 user:
 171   # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
 172   # -1 == unlimited
 173   video_quota: -1
 174   video_quota_daily: -1
 175
 176 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
 177 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
 178 # Please, do not disable transcoding since many uploaded videos will not work
 179 transcoding:
 180   enabled: true
 181   # Allow your users to upload .mkv, .mov, .avi, .flv videos
 182   allow_additional_extensions: true
 183   # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
 184   allow_audio_files: true
 185   threads: 1
 186   resolutions: # Only created if the original video has a higher resolution, uses more storage!
 187     240p: false
 188     360p: false
 189     480p: false
 190     720p: false
 191     1080p: false
 192   # /!\ EXPERIMENTAL /!\
 193   # /!\ Requires ffmpeg >= 4
 194   # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
 195   #     * Resolution change is smoother
 196   #     * Faster playback in particular with long videos
 197   #     * More stable playback (less bugs/infinite loading)
 198   # /!\ Multiplies videos storage by 2 /!\
 199   hls:
 200     enabled: false
 201
 202 import:
 203   # Add ability for your users to import remote videos (from YouTube, torrent...)
 204   videos:
 205     http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
 206       enabled: false
 207     torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
 208       enabled: false
 209
 210 auto_blacklist:
 211   # New videos automatically blacklisted so moderators can review before publishing
 212   videos:
 213     of_users:
 214       enabled: false
 215
 216 instance:
 217   name: 'PeerTube'
 218   short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
 219   description: 'Welcome to this PeerTube instance!' # Support markdown
 220   terms: 'No terms for now.' # Support markdown
 221   default_client_route: '/videos/trending'
 222   # Whether or not the instance is dedicated to NSFW content
 223   # Enabling it will allow other administrators to know that you are mainly federating sensitive content
 224   # Moreover, the NSFW checkbox on video upload will be automatically checked by default
 225   is_nsfw: false
 226   # By default, "do_not_list" or "blur" or "display" NSFW videos
 227   # Could be overridden per user with a setting
 228   default_nsfw_policy: 'do_not_list'
 229   customizations:
 230     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
 231     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
 232   # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
 233   robots: |
 234     User-agent: *
 235     Disallow:
 236   # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
 237   securitytxt:
 238     "# 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:"
 239
 240 services:
 241   # Cards configuration to format video in Twitter
 242   twitter:
 243     username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
 244     # If true, a video player will be embedded in the Twitter feed on PeerTube video share
 245     # If false, we use an image link card that will redirect on your PeerTube instance
 246     # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
 247     whitelisted: false
 248
 249 followers:
 250   instance:
 251     # Allow or not other instances to follow yours
 252     enabled: true
 253     # Whether or not an administrator must manually validate a new follower
 254     manual_approval: false