X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=config%2Fproduction.yaml.example;h=94238fad00f6bb70a968b28d45d2d5f2e1cc4059;hb=32e06ca4de8480e3b6d4542ef5cd7381b3795465;hp=ca9c16739b87022fc117d6cc5923523de8be1f99;hpb=b0ce7c39dce4be8d7c2775e8205f8abfe348a0de;p=github%2FChocobozzz%2FPeerTube.git diff --git a/config/production.yaml.example b/config/production.yaml.example index ca9c16739..94238fad0 100644 --- 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' @@ -75,7 +75,7 @@ email: # 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... avatars: '/var/www/peertube/storage/avatars/' videos: '/var/www/peertube/storage/videos/' streaming_playlists: '/var/www/peertube/storage/streaming-playlists/' @@ -90,20 +90,62 @@ storage: # Overridable client files : logo.svg, favicon.png and icons/*.png (PWA) in client/dist/assets/images # 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' + + 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 + 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 @@ -142,6 +184,11 @@ 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 @@ -167,7 +214,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 @@ -179,8 +226,20 @@ plugins: federation: videos: - federate_unlisted: true + 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 + # 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 + +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' ############################################################################### # @@ -199,6 +258,8 @@ cache: 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 @@ -211,6 +272,7 @@ contact_form: signup: enabled: false limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited + minimum_age: 16 requires_email_verification: false filters: cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist @@ -228,11 +290,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,13 +314,14 @@ 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) # 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: @@ -255,13 +330,64 @@ 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 + + # Limit lives duration + # -1 == unlimited + max_duration: -1 # For example: '5 hours' + + # Limit max number of live videos created on your instance + # -1 == unlimited + max_instance_lives: 20 + + # Limit max number of live videos created by a user on your instance + # -1 == unlimited + max_user_lives: 3 + + # Allow your users to save a replay of their 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: 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: 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 @@ -278,7 +404,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 @@ -287,16 +413,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..."