X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=config%2Fdefault.yaml;h=f7c9b620c9d5967f770356730ed4a36701c186bd;hb=714e33a7428b71ef98129ce85a4bd64140bcd912;hp=43c7f4a53ee6c63cbe5edbd9c6033d26b8dc183b;hpb=3da68f0a781ebd893521e2e6fa200280c92ae815;p=github%2FChocobozzz%2FPeerTube.git diff --git a/config/default.yaml b/config/default.yaml index 43c7f4a53..f7c9b620c 100644 --- a/config/default.yaml +++ b/config/default.yaml @@ -14,7 +14,7 @@ rates_limit: api: # 50 attempts in 10 seconds window: 10 seconds - max: 100 + max: 50 login: # 15 attempts in 5 min window: 5 minutes @@ -34,7 +34,7 @@ rates_limit: trust_proxy: - 'loopback' -# Your database name will be database.name OR "peertube"+database.suffix +# Your database name will be database.name OR 'peertube'+database.suffix database: hostname: 'localhost' port: 5432 @@ -45,37 +45,68 @@ database: pool: max: 5 +# 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 auth: null db: 0 +# SMTP server to send emails smtp: # smtp or sendmail transport: smtp # Path to sendmail command. Required if you use sendmail transport sendmail: null 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' email: body: - signature: "PeerTube" + signature: 'PeerTube' subject: - prefix: "[PeerTube]" + prefix: '[PeerTube]' + +# 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 in PeerTube client + # Can be enabled/disabled by anonymous users and logged in users + webapp: + enabled: true + + # Enable P2P by default in PeerTube embed + # Can be enabled/disabled by URL option + embed: + enabled: true # From the project root directory storage: - tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before processing... + tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing... + bin: 'storage/bin/' avatars: 'storage/avatars/' videos: 'storage/videos/' streaming_playlists: 'storage/streaming-playlists/' @@ -87,25 +118,73 @@ storage: captions: 'storage/captions/' cache: 'storage/cache/' plugins: 'storage/plugins/' - # Overridable client files : logo.svg, favicon.png and icons/*.png (PWA) in client/dist/assets/images + # Overridable client files in client/dist/assets/images: + # - logo.svg + # - favicon.png + # - default-playlist.jpg + # - default-avatar-account.png + # - default-avatar-video-channel.png + # - and icons/*.png (PWA) # Could contain for example assets/images/favicon.png # If the file exists, peertube will serve it - # If not, peertube will fallback to the default fil + # If not, peertube will fallback to the default file client_overrides: 'storage/client-overrides/' +object_storage: + enabled: false + + # Without protocol, will default to HTTPS + endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example + + region: 'us-east-1' + + # Set this ACL on each uploaded object + upload_acl: 'public-read' + + credentials: + # You can also use AWS_ACCESS_KEY_ID env variable + access_key_id: '' + # You can also use AWS_SECRET_ACCESS_KEY env variable + secret_access_key: '' + + # Maximum amount to upload in one request to object storage + max_upload_part: 2GB + + streaming_playlists: + bucket_name: 'streaming-playlists' + + # Allows setting all buckets to the same value but with a different prefix + prefix: '' # Example: 'streaming-playlists:' + + # Base url for object URL generation, scheme and host will be replaced by this URL + # Useful when you want to use a CDN/external proxy + base_url: '' # Example: 'https://mirror.example.com' + + # Same settings but for webtorrent videos + videos: + bucket_name: 'videos' + prefix: '' + base_url: '' + log: - level: 'info' # debug/info/warning/error + level: 'info' # 'debug' | 'info' | 'warn' | 'error' rotation: - enabled : true - maxFileSize: 12MB - maxFiles: 20 - anonymizeIP: false + 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 prettify_sql: false trending: videos: interval_days: 7 # Compute trending videos for the last x days + algorithms: + enabled: + - '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 @@ -144,11 +223,16 @@ csp: report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk! report_uri: +security: + # Set the X-Frame-Options header to help to mitigate clickjacking attacks + frameguard: + enabled: true + tracker: - # If you disable the tracker, you disable the P2P aspect of PeerTube + # If you disable the tracker, you disable the P2P on your PeerTube instance 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) @@ -171,6 +255,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 @@ -183,11 +279,40 @@ federation: videos: federate_unlisted: false + # 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 + cleanup_remote_interactions: true + +peertube: + check_latest_version: + # Check and notify admins of new PeerTube versions + enabled: true + # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json + url: 'https://joinpeertube.org/api/v1/versions.json' + +webadmin: + configuration: + edition: + # 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 captions: size: 500 # Max number of video captions/subtitles you want to cache + torrents: + size: 500 # Max number of video torrents you want to cache admin: # Used to generate the root user at first startup @@ -200,6 +325,7 @@ contact_form: signup: enabled: false limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited + minimum_age: 16 # Used to configure the signup form requires_email_verification: false filters: cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist @@ -207,23 +333,40 @@ 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 -# 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. +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 # 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) + 144p: false 240p: false 360p: false 480p: false @@ -236,7 +379,7 @@ transcoding: # If you also enabled the hls format, it will multiply videos storage by 2 # If disabled, breaks federation with PeerTube instances < 2.1 webtorrent: - enabled: true + enabled: false # /!\ Requires ffmpeg >= 4.1 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent: @@ -245,7 +388,7 @@ transcoding: # * More stable playback (less bugs/infinite loading) # If you also enabled the webtorrent format, it will multiply videos storage by 2 hls: - enabled: false + enabled: true live: enabled: false @@ -266,18 +409,57 @@ live: # PeerTube will transcode segments in a video file # If the user daily/total quota is reached, PeerTube will stop the live # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay - allow_replay: false + 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 + + # 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 + # 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 paths + key_file: '' + cert_file: '' + + # 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: enabled: true threads: 2 + # Choose the transcoding profile + # New profiles can be added by plugins + # Available in core PeerTube: 'default' + profile: 'default' + resolutions: + 144p: false 240p: false 360p: false 480p: false @@ -286,20 +468,48 @@ live: 1440p: false 2160p: false +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: # Add ability for your users to import remote videos (from YouTube, torrent...) videos: - http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html + # 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 + # 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: @@ -308,6 +518,7 @@ auto_blacklist: of_users: enabled: false +# Instance settings instance: name: 'PeerTube' short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.' @@ -331,7 +542,7 @@ instance: business_model: '' # Supports Markdown # If you want to explain on what type of hardware your PeerTube instance runs - # Example: "2 vCore, 2GB RAM..." + # Example: '2 vCore, 2GB RAM...' hardware_information: '' # Supports Markdown # What are the main languages of your instance? To interact with your users for example @@ -366,29 +577,25 @@ instance: # - 18 # Food default_client_route: '/videos/trending' - default_trending_route: '/videos/most-viewed' - pages: - hot: - enabled: true # Whether or not the instance is dedicated to NSFW content # Enabling it will allow other administrators to know that you are mainly federating sensitive content # Moreover, the NSFW checkbox on video upload will be automatically checked by default is_nsfw: false - # By default, "do_not_list" or "blur" or "display" NSFW videos + # By default, `do_not_list` or `blur` or `display` NSFW videos # Could be overridden per user with a setting default_nsfw_policy: 'do_not_list' customizations: javascript: '' # Directly your JavaScript code (without