]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - config/production.yaml.example
Clearer message regarding SQL extension commands in beta 10
[github/Chocobozzz/PeerTube.git] / config / production.yaml.example
index 51d5c51808410ef1386171b11002a18797846fd2..d347b0ece221d27cd38536b05cd0346637644b85 100644 (file)
@@ -23,6 +23,8 @@ database:
   password: 'peertube'
 
 # Redis server for short time storage
+# You can also specify a 'socket' path to a unix socket but first need to
+# comment out hostname and port
 redis:
   hostname: 'localhost'
   port: 6379
@@ -32,10 +34,10 @@ redis:
 # SMTP server to send emails
 smtp:
   hostname: null
-  port: 465
+  port: 465 # If you use StartTLS: 587
   username: null
   password: null
-  tls: true
+  tls: true # If you use StartTLS: false
   disable_starttls: false
   ca_file: null # Used for self signed certificates
   from_address: 'admin@example.com'
@@ -48,6 +50,7 @@ storage:
   previews: '/var/www/peertube/storage/previews/'
   thumbnails: '/var/www/peertube/storage/thumbnails/'
   torrents: '/var/www/peertube/storage/torrents/'
+  captions: '/var/www/peertube/storage/captions/'
   cache: '/var/www/peertube/storage/cache/'
 
 log:
@@ -68,7 +71,9 @@ log:
 
 cache:
   previews:
-    size: 100 # Max number of previews you want to cache
+    size: 500 # Max number of previews you want to cache
+  captions:
+    size: 500 # Max number of video captions/subtitles you want to cache
 
 admin:
   email: 'admin@example.com'
@@ -76,6 +81,10 @@ admin:
 signup:
   enabled: false
   limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
+  filters:
+    cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
+      whitelist: []
+      blacklist: []
 
 user:
   # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
@@ -83,11 +92,12 @@ user:
   video_quota: -1
 
 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
-# Uses a lot of CPU!
+# In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
+# Please, do not disable transcoding since many uploaded videos will not work
 transcoding:
   enabled: true
   threads: 1
-  resolutions: # Only created if the original video has a higher resolution
+  resolutions: # Only created if the original video has a higher resolution, uses more storage!
     240p: false
     360p: false
     480p: false
@@ -107,16 +117,16 @@ instance:
   customizations:
     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
-  # Robot.txt rules. To allow robots to crawl your instance and allow indexation of your site, remove the '/'
+  # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
   robots: |
     User-agent: *
-    Disallow: /
+    Disallow: ''
 
 services:
   # Cards configuration to format video in Twitter
   twitter:
-    username: '@Chocobozzz' # The Twitter @username the card should be attributed to
+    username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
     # If true, a video player will be embedded in the Twitter feed on PeerTube video share
     # If false, we use an image link card that will redirect on your PeerTube instance
     # Test on https://cards-dev.twitter.com/validator to see if you are whitelisted
-    whitelisted: false
\ No newline at end of file
+    whitelisted: false