X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=config%2Fdefault.yaml;h=d4977d0037e425c92072a94840b8e022c9dab186;hb=b65f5367baf799b425be0bcfb9220922751bb6eb;hp=6db8d3803b58f6e7bf1f0e5e741bbdfeffdbe23d;hpb=f9915efa5ea0714178fc60d11a0d5434e7b1e600;p=github%2FChocobozzz%2FPeerTube.git diff --git a/config/default.yaml b/config/default.yaml index 6db8d3803..d4977d003 100644 --- a/config/default.yaml +++ b/config/default.yaml @@ -10,6 +10,11 @@ webserver: hostname: 'localhost' port: 9000 +# Secrets you need to generate the first time you run PeerTube +secrets: + # Generate one using `openssl rand -hex 32` + peertube: '' + rates_limit: api: # 50 attempts in 10 seconds @@ -27,6 +32,15 @@ rates_limit: # 3 attempts in 5 min window: 5 minutes max: 3 + receive_client_log: + # 10 attempts in 10 min + window: 10 minutes + max: 10 + +oauth2: + token_lifetime: + access_token: '1 day' + refresh_token: '2 weeks' # Proxies to trust to get real client IP # If you run PeerTube just behind a local proxy (nginx), keep 'loopback' @@ -47,7 +61,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 @@ -118,6 +132,7 @@ storage: captions: 'storage/captions/' cache: 'storage/cache/' plugins: 'storage/plugins/' + well_known: 'storage/well-known/' # Overridable client files in client/dist/assets/images: # - logo.svg # - favicon.png @@ -130,6 +145,10 @@ storage: # If not, peertube will fallback to the default file client_overrides: 'storage/client-overrides/' +static_files: + # Require and check user authentication when accessing private files (internal/private video files) + private_files_require_auth: true + object_storage: enabled: false @@ -138,8 +157,19 @@ object_storage: region: 'us-east-1' - # Set this ACL on each uploaded object - upload_acl: 'public-read' + upload_acl: + # Set this ACL on each uploaded object of public/unlisted videos + public: 'public-read' + # Set this ACL on each uploaded object of private/internal videos + # PeerTube can proxify requests to private objects so your users can access them + private: 'private' + + proxy: + # If private files (private/internal video files) have a private ACL, users can't access directly the ressource + # PeerTube can proxify requests between your object storage service and your users + # If you disable PeerTube proxy, ensure you use your own proxy that is able to access the private files + # Or you can also set a public ACL for private files in object storage if you don't want to use a proxy + proxify_private_files: true credentials: # You can also use AWS_ACCESS_KEY_ID env variable @@ -148,7 +178,7 @@ object_storage: secret_access_key: '' # Maximum amount to upload in one request to object storage - max_upload_part: 2GB + max_upload_part: 100MB streaming_playlists: bucket_name: 'streaming-playlists' @@ -168,20 +198,45 @@ object_storage: log: level: 'info' # 'debug' | 'info' | 'warn' | 'error' + rotation: enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate max_file_size: 12MB max_files: 20 + anonymize_ip: false + log_ping_requests: true + log_tracker_unknown_infohash: true + prettify_sql: false + # Accept warn/error logs coming from the client + accept_client_log: true + +# Support of Open Telemetry metrics and tracing +# For more information: https://docs.joinpeertube.org/maintain-observability +open_telemetry: + metrics: + enabled: false + + # Create a prometheus exporter server on this port so prometheus server can scrape PeerTube metrics + prometheus_exporter: + hostname: '127.0.0.1' + port: 9091 + + tracing: + enabled: false + + # Send traces to a Jaeger compatible endpoint + jaeger_exporter: + endpoint: '' + 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' @@ -261,6 +316,13 @@ views: 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 @@ -290,6 +352,16 @@ webadmin: # Set this to false if you don't want to allow config edition in the web interface by instance admins allowed: true +# XML, Atom or JSON feeds +feeds: + videos: + # Default number of videos displayed in feeds + count: 20 + + comments: + # Default number of comments displayed in feeds + count: 20 + cache: previews: size: 500 # Max number of previews you want to cache @@ -359,6 +431,9 @@ transcoding: 1440p: false 2160p: false + # Transcode and keep original resolution, even if it's above your maximum enabled resolution + always_transcode_original_resolution: true + # Generate videos in a WebTorrent format (what we do since the first PeerTube release) # If you also enabled the hls format, it will multiply videos storage by 2 # If disabled, breaks federation with PeerTube instances < 2.1 @@ -404,17 +479,33 @@ live: # Your firewall should accept traffic from this port in TCP if you enable live rtmp: enabled: true + + # Listening hostname/port for RTMP server + # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4 + # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise + hostname: null port: 1935 - hostname: 'localhost' + + # Public hostname of your RTMP server + # Use null to use the same value than `webserver.hostname` + public_hostname: null rtmps: enabled: false + + # Listening hostname/port for RTMPS server + # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4 + # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise + hostname: null port: 1936 - # Absolute path + + # Absolute paths key_file: '' - # Absolute path cert_file: '' - hostname: 'localhost' + + # Public hostname of your RTMPS server + # Use null to use the same value than `webserver.hostname` + public_hostname: null # Allow to transcode the live streaming in multiple live resolutions transcoding: @@ -436,8 +527,12 @@ live: 1440p: false 2160p: false -video_editor: + # Also transcode original resolution, even if it's above your maximum enabled resolution + always_transcode_original_resolution: true + +video_studio: # Enable video edition by users (cut, add intro/outro, add watermark etc) + # If enabled, users can create transcoding tasks as they wish enabled: false import: @@ -446,6 +541,9 @@ import: # Amount of import jobs to execute in parallel concurrency: 1 + # Set a custom video import timeout to not block import queue + timeout: '2 hours' + # 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 @@ -458,11 +556,11 @@ import: # 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' + # * https://yt-dl.org/downloads/latest/youtube-dl + url: 'https://api.github.com/repos/yt-dlp/yt-dlp/releases' - # youtube-dl binary name - # yt-dlp is also supported - name: 'youtube-dl' + # Release binary name: 'yt-dlp' or 'youtube-dl' + name: 'yt-dlp' # Path to the python binary to execute for youtube-dl or yt-dlp python_path: '/usr/bin/python3' @@ -476,6 +574,20 @@ import: # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information enabled: false + # Add ability for your users to synchronize their channels with external channels, playlists, etc + video_channel_synchronization: + enabled: false + + max_per_user: 10 + + check_interval: 1 hour + + # Number of latest published videos to check and to potentially import when syncing a channel + videos_limit_per_synchronization: 10 + + # Max number of videos to import when the user asks for full sync + full_sync_videos_limit: 1000 + auto_blacklist: # New videos automatically blacklisted so moderators can review before publishing videos: @@ -557,7 +669,8 @@ 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 + # /.well-known/security.txt rules. This endpoint is cached, so you may have to wait a few hours before viewing your changes + # 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:' @@ -622,9 +735,9 @@ search: # You should deploy your own with https://framagit.org/framasoft/peertube/search-index, # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index url: '' - # You can disable local search, so users only use the search index + # You can disable local search in the client, so users only use the search index disable_local_search: false - # If you did not disable local search, you can decide to use the search index by default + # If you did not disable local search in the client, you can decide to use the search index by default is_default_search: false # PeerTube client/interface configuration