X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=config%2Fproduction.yaml.example;h=8efe07c010e31606bb698e16293bc4f382120adf;hb=92e66e04f7f51d37b465cff442ce47f6d6d7cadd;hp=f2e75af32935748e18c772ce33e826780022d93d;hpb=dc48fdbe68e9dd3a3a6028181e61d8595d98e654;p=github%2FChocobozzz%2FPeerTube.git diff --git a/config/production.yaml.example b/config/production.yaml.example index f2e75af32..8efe07c01 100644 --- a/config/production.yaml.example +++ b/config/production.yaml.example @@ -32,7 +32,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 @@ -69,13 +69,40 @@ smtp: 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 + # 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 processing... + 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/' @@ -87,19 +114,61 @@ storage: captions: '/var/www/peertube/storage/captions/' cache: '/var/www/peertube/storage/cache/' plugins: '/var/www/peertube/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: '/var/www/peertube/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' + + 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 # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate - maxFileSize: 12MB - maxFiles: 20 - anonymizeIP: false + max_file_size: 12MB + max_files: 20 + anonymize_ip: false log_ping_requests: true prettify_sql: false @@ -151,11 +220,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 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) @@ -178,6 +252,11 @@ 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' + 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 @@ -192,9 +271,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: @@ -203,15 +280,21 @@ peertube: # 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 + ############################################################################### # # 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 /!\ # ############################################################################### @@ -234,6 +317,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 @@ -241,13 +325,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 -# 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 @@ -270,6 +358,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 @@ -314,9 +403,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: @@ -329,6 +435,7 @@ live: profile: 'default' resolutions: + 144p: false 240p: false 360p: false 480p: false @@ -337,23 +444,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: @@ -386,7 +514,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 @@ -426,20 +554,20 @@ instance: # 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