]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - config/production.yaml.example
Fix redis config comment
[github/Chocobozzz/PeerTube.git] / config / production.yaml.example
index d023070e3c7a47341ee6bc7e9a3778d095433b60..8bdd30e2d48de91a53e4ee3bd7f39397893c75d3 100644 (file)
@@ -45,7 +45,7 @@ database:
 
 # 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
+# set 'hostname' and 'port' to null
 redis:
   hostname: 'localhost'
   port: 6379
@@ -73,16 +73,36 @@ email:
   subject:
     prefix: '[PeerTube]'
 
-# PeerTube client/interface configuration
-client:
-  videos:
-    miniature:
-      # By default PeerTube client displays author username
-      prefer_author_display_name: false
+# Update default PeerTube values
+# Set by API when the field is not provided and put as default value in client
+defaults:
+  # Change default values when publishing a video (upload/import/go Live)
+  publish:
+    download_enabled: true
+
+    comments_enabled: true
+
+    # public = 1, unlisted = 2, private = 3, internal = 4
+    privacy: 1
+
+    # CC-BY = 1, CC-SA = 2, CC-ND = 3, CC-NC = 4, CC-NC-SA = 5, CC-NC-ND = 6, Public Domain = 7
+    # You can also choose a custom licence value added by a plugin
+    # No licence by default
+    licence: null
+
+  p2p:
+    # Enable P2P by default
+    # Can be enabled/disabled by anonymous users and logged in users
+    webapp:
+      enabled: true
+
+    embed:
+      enabled: true
 
 # From the project root directory
 storage:
   tmp: '/var/www/peertube/storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
+  bin: '/var/www/peertube/storage/bin/'
   avatars: '/var/www/peertube/storage/avatars/'
   videos: '/var/www/peertube/storage/videos/'
   streaming_playlists: '/var/www/peertube/storage/streaming-playlists/'
@@ -114,6 +134,9 @@ object_storage:
 
   region: 'us-east-1'
 
+  # Set this ACL on each uploaded object
+  upload_acl: 'public'
+
   credentials:
     # You can also use AWS_ACCESS_KEY_ID env variable
     access_key_id: ''
@@ -205,8 +228,8 @@ security:
 tracker:
   # If you disable the tracker, you disable the P2P aspect of PeerTube
   enabled: true
-  # Only handle requests on your videos.
-  # If you set this to false it means you have a public tracker.
+  # Only handle requests on your videos
+  # If you set this to false it means you have a public tracker
   # Then, it is possible that clients overload your instance with external torrents
   private: true
   # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
@@ -229,6 +252,18 @@ views:
     remote:
       max_age: '30 days'
 
+    # PeerTube buffers local video views before updating and federating the video
+    local_buffer_update_interval: '30 minutes'
+
+    ip_view_expiration: '1 hour'
+
+# Used to get country location of views of local videos
+geo_ip:
+  enabled: true
+
+  country:
+    database_url: 'https://dbip.mirror.framasoft.org/files/dbip-country-lite-latest.mmdb'
+
 plugins:
   # The website PeerTube will ask for available PeerTube plugins and themes
   # This is an unmoderated plugin index, so only install plugins/themes you trust
@@ -243,9 +278,7 @@ federation:
 
     # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
     # It removes objects that do not exist anymore, and potentially fix their URLs
-    # This setting is opt-in because due to an old bug in PeerTube, remote rates sent by instance before PeerTube 3.0 will be deleted
-    # We still suggest you to enable this setting even if your users will loose most of their video's likes/dislikes
-    cleanup_remote_interactions: false
+    cleanup_remote_interactions: true
 
 peertube:
   check_latest_version:
@@ -265,10 +298,10 @@ webadmin:
 # 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.
+# 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 /!\.
+# following keys will have no effect /!\
 #
 ###############################################################################
 
@@ -299,13 +332,17 @@ signup:
       blacklist: []
 
 user:
-  # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
+  # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
+  # Byte format is supported ("1GB" etc)
   # -1 == unlimited
   video_quota: -1
   video_quota_daily: -1
 
+video_channels:
+  max_per_user: 20 # Allows each user to create up to 20 video channels.
+
 # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
-# In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
+# 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
@@ -328,6 +365,7 @@ transcoding:
 
   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)
+    144p: false
     240p: false
     360p: false
     480p: false
@@ -372,9 +410,26 @@ live:
   # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
   allow_replay: true
 
+  # Allow your users to change latency settings (small latency/default/high latency)
+  # Small latency live streams cannot use P2P
+  # High latency live streams can increase P2P ratio
+  latency_setting:
+    enabled: true
+
   # Your firewall should accept traffic from this port in TCP if you enable live
   rtmp:
+    enabled: true
     port: 1935
+    hostname: 'localhost'
+
+  rtmps:
+    enabled: false
+    port: 1936
+    # Absolute path
+    key_file: ''
+    # Absolute path
+    cert_file: ''
+    hostname: 'localhost'
 
   # Allow to transcode the live streaming in multiple live resolutions
   transcoding:
@@ -387,6 +442,7 @@ live:
     profile: 'default'
 
     resolutions:
+      144p: false
       240p: false
       360p: false
       480p: false
@@ -395,23 +451,44 @@ live:
       1440p: false
       2160p: false
 
+video_studio:
+  # Enable video edition by users (cut, add intro/outro, add watermark etc)
+  enabled: 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
+    # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
+    http:
+      # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server
+      # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
       enabled: false
 
+      youtube_dl_release:
+        # Direct download URL to youtube-dl binary
+        # Github releases API is also supported
+        # Examples:
+        #   * https://api.github.com/repos/ytdl-org/youtube-dl/releases
+        #   * https://api.github.com/repos/yt-dlp/yt-dlp/releases
+        url: 'https://yt-dl.org/downloads/latest/youtube-dl'
+
+        # youtube-dl binary name
+        # yt-dlp is also supported
+        name: 'youtube-dl'
+
+        # Path to the python binary to execute for youtube-dl or yt-dlp
+        python_path: '/usr/bin/python3'
+
       # 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
-        url: ''
-    torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
+    # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
+    torrent:
+      # We recommend to only enable magnet URI/torrent import if you trust your users
+      # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
       enabled: false
 
 auto_blacklist:
@@ -495,7 +572,7 @@ instance:
   robots: |
     User-agent: *
     Disallow:
-  # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
+  # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
   securitytxt:
     '# 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:'
 
@@ -564,3 +641,21 @@ search:
     disable_local_search: false
     # If you did not disable local search, you can decide to use the search index by default
     is_default_search: false
+
+# PeerTube client/interface configuration
+client:
+  videos:
+    miniature:
+      # By default PeerTube client displays author username
+      prefer_author_display_name: false
+      display_author_avatar: false
+    resumable_upload:
+      # Max size of upload chunks, e.g. '90MB'
+      # If null, it will be calculated based on network speed
+      max_chunk_size: null
+
+  menu:
+    login:
+      # If you enable only one external auth plugin
+      # You can automatically redirect your users on this external platform when they click on the login button
+      redirect_on_single_external_auth: false