Misc. typos

[oweals/peertube.git] / config / production.yaml.example

diff --git a/config/production.yaml.example b/config/production.yaml.example
index 9d233a84715fc5de96ebf215f9138bcade4575cc..c963118d943a6759824faa1aa4e330d87dbfbc86 100644 (file)
--- a/config/production.yaml.example
+++ b/config/production.yaml.example
@@ -7,6 +7,12 @@ webserver:
   hostname: 'example.com'
   port: 443
 
+# Proxies to trust to get real client IP
+# If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
+# If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
+trust_proxy:
+  - 'loopback'
+
 # Your database name will be "peertube"+database.suffix
 database:
   hostname: 'localhost'
@@ -15,17 +21,20 @@ database:
   username: 'peertube'
   password: 'peertube'
 
+# Redis server for short time storage
 redis:
   hostname: 'localhost'
   port: 6379
   auth: null
 
+# SMTP server to send emails
 smtp:
   hostname: null
   port: 465
   username: null
   password: null
   tls: true
+  disable_starttls: false
   ca_file: null # Used for self signed certificates
   from_address: 'admin@example.com'
 
@@ -42,6 +51,19 @@ storage:
 log:
   level: 'info' # debug/info/warning/error
 
+
+###############################################################################
+#
+# From this point, all the following keys can be overridden by the web interface
+# (local-production.json file). If you need to change some values, prefer to
+# use the web interface because the configuration will be automatically
+# reloaded without any need to restart PeerTube.
+#
+# /!\ If you already have a local-production.json file, the modification of the
+# following keys will have no effect /!\.
+#
+###############################################################################
+
 cache:
   previews:
     size: 100 # Max number of previews you want to cache
@@ -61,16 +83,22 @@ user:
 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
 # Uses a lot of CPU!
 transcoding:
-  enabled: false
-  threads: 2
+  enabled: true
+  threads: 1
   resolutions: # Only created if the original video has a higher resolution
-    240p: true
-    360p: true
-    480p: true
-    720p: true
-    1080p: true
+    240p: false
+    360p: false
+    480p: false
+    720p: false
+    1080p: false
 
+# Instance settings
 instance:
   name: 'PeerTube'
+  short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
   description: '' # Support markdown
   terms: '' # Support markdown
+  default_client_route: '/videos/trending'
+  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