Allow to specify transcoding and import jobs concurrency

[github/Chocobozzz/PeerTube.git] / config / production.yaml.example

diff --git a/config/production.yaml.example b/config/production.yaml.example
index 6c331b8b3148641a531552b5de7794bd9b288c23..d75e302760795ceb900abdd33b49f968231c2555 100644 (file)
--- a/config/production.yaml.example
+++ b/config/production.yaml.example
@@ -2,7 +2,7 @@ listen:
   hostname: 'localhost'
   port: 9000
 
-# Correspond to your reverse proxy server_name/listen configuration
+# Correspond to your reverse proxy server_name/listen configuration (i.e., your public PeerTube instance URL)
 webserver:
   https: true
   hostname: 'example.com'
@@ -100,10 +100,19 @@ log:
     maxFileSize: 12MB
     maxFiles: 20
   anonymizeIP: false
+  log_ping_requests: true
+  prettify_sql: false
 
 trending:
   videos:
     interval_days: 7 # Compute trending videos for the last x days
+    algorithms:
+      enabled:
+        - 'best' # adaptation of Reddit's 'Best' algorithm (Hot minus History)
+        - 'hot' # adaptation of Reddit's 'Hot' algorithm
+        - 'most-viewed' # default, used initially by PeerTube as the trending page
+        - 'most-liked'
+      default: 'most-viewed'
 
 # Cache remote videos on your server, to help other instances to broadcast the video
 # You can define multiple caches using different sizes/strategies
@@ -167,7 +176,7 @@ views:
     # -1 means no cleanup
     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
     remote:
-      max_age: -1
+      max_age: '30 days'
 
 plugins:
   # The website PeerTube will ask for available PeerTube plugins and themes
@@ -228,11 +237,23 @@ user:
 # Please, do not disable transcoding since many uploaded videos will not work
 transcoding:
   enabled: true
+
   # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
   allow_additional_extensions: true
+
   # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
   allow_audio_files: true
+
+  # Amount of threads used by ffmpeg for 1 transcoding job
   threads: 1
+  # Amount of transcoding jobs to execute in parallel
+  concurrency: 1
+
+  # Choose the transcoding profile
+  # New profiles can be added by plugins
+  # Available in core PeerTube: 'default'
+  profile: 'default'
+
   resolutions: # Only created if the original video has a higher resolution, uses more storage!
     0p: false # audio-only (creates mp4 without video stream, always created when enabled)
     240p: false
@@ -240,6 +261,7 @@ transcoding:
     480p: false
     720p: false
     1080p: false
+    1440p: false
     2160p: false
 
   # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
@@ -261,8 +283,8 @@ live:
   enabled: false
 
   # Limit lives duration
-  # Set null to disable duration limit
-  max_duration: 5 hours
+  # -1 == unlimited
+  max_duration: -1 # For example: '5 hours'
 
   # Limit max number of live videos created on your instance
   # -1 == unlimited
@@ -278,27 +300,41 @@ live:
   # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
   allow_replay: true
 
+  # Your firewall should accept traffic from this port in TCP if you enable live
   rtmp:
     port: 1935
 
   # Allow to transcode the live streaming in multiple live resolutions
   transcoding:
-    enabled: false
+    enabled: true
     threads: 2
 
+    # Choose the transcoding profile
+    # New profiles can be added by plugins
+    # Available in core PeerTube: 'default'
+    profile: 'default'
+
     resolutions:
       240p: false
       360p: false
       480p: false
       720p: false
       1080p: false
+      1440p: false
       2160p: false
 
 import:
   # Add ability for your users to import remote videos (from YouTube, torrent...)
   videos:
+    # Amount of import jobs to execute in parallel
+    concurrency: 1
+
     http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
       enabled: false
+
+      # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
+      force_ipv4: false
+
       # You can use an HTTP/HTTPS/SOCKS proxy with youtube-dl
       proxy:
         enabled: false
@@ -315,7 +351,7 @@ auto_blacklist:
 # 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.'
+  short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
   description: 'Welcome to this PeerTube instance!' # Support markdown
   terms: 'No terms for now.' # Support markdown
   code_of_conduct: '' # Supports markdown
@@ -324,16 +360,16 @@ instance:
   moderation_information: '' # Supports markdown
 
   # Why did you create this instance?
-  creation_reason: ''
+  creation_reason: '' # Supports Markdown
 
   # Who is behind the instance? A single person? A non profit?
-  administrator: ''
+  administrator: '' # Supports Markdown
 
   # How long do you plan to maintain this instance?
-  maintenance_lifetime: ''
+  maintenance_lifetime: '' # Supports Markdown
 
   # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
-  business_model: ''
+  business_model: '' # Supports Markdown
 
   # If you want to explain on what type of hardware your PeerTube instance runs
   # Example: "2 vCore, 2GB RAM..."