X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=config%2Fproduction.yaml.example;h=db9c18cb833c16f63984248efb76c7b6dffc8864;hb=fabe350bcac2d24c8524d4b6bb776dba7e374c8d;hp=dafc15915e4a65b2f90c7fa49c7692d3ec2e702e;hpb=0d6843decdaecb4f726cba27fdb55fc164d00ba7;p=github%2FChocobozzz%2FPeerTube.git diff --git a/config/production.yaml.example b/config/production.yaml.example index dafc15915..db9c18cb8 100644 --- a/config/production.yaml.example +++ b/config/production.yaml.example @@ -8,6 +8,11 @@ webserver: hostname: 'example.com' port: 443 +# 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 @@ -30,6 +35,11 @@ rates_limit: 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' # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet) @@ -108,6 +118,7 @@ defaults: # 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... + tmp_persistent: '/var/www/peertube/storage/tmp-persistent/' # As tmp but the directory is not cleaned up between PeerTube restarts bin: '/var/www/peertube/storage/bin/' avatars: '/var/www/peertube/storage/avatars/' videos: '/var/www/peertube/storage/videos/' @@ -120,6 +131,7 @@ storage: captions: '/var/www/peertube/storage/captions/' cache: '/var/www/peertube/storage/cache/' plugins: '/var/www/peertube/storage/plugins/' + well_known: '/var/www/peertube/storage/well-known/' # Overridable client files in client/dist/assets/images: # - logo.svg # - favicon.png @@ -132,6 +144,10 @@ storage: # If not, peertube will fallback to the default file client_overrides: '/var/www/peertube/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 @@ -140,8 +156,21 @@ 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 + # Use null if your S3 provider does not support object ACL + 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 + # Use null if your S3 provider does not support object ACL + 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 @@ -186,13 +215,19 @@ log: # Accept warn/error logs coming from the client accept_client_log: true -# Highly experimental support of Open Telemetry +# Support of Open Telemetry metrics and tracing +# For more information: https://docs.joinpeertube.org/maintain/observability open_telemetry: metrics: enabled: false + http_request_duration: + # You can disable HTTP request duration metric that can have a high tag cardinality + enabled: true + # 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: @@ -204,12 +239,14 @@ open_telemetry: trending: videos: - interval_days: 7 # Compute trending videos for the last x days + interval_days: 7 # Compute trending videos for the last x days for 'most-viewed' algorithm + algorithms: enabled: - - 'hot' # adaptation of Reddit's 'Hot' algorithm - - 'most-viewed' # default, used initially by PeerTube as the trending page - - 'most-liked' + - 'hot' # Adaptation of Reddit's 'Hot' algorithm + - 'most-viewed' # Number of views in the last x days + - 'most-liked' # Global views since the upload of the video + default: 'most-viewed' # Cache remote videos on your server, to help other instances to broadcast the video @@ -254,6 +291,11 @@ security: frameguard: enabled: true + # Set x-powered-by HTTP header to "PeerTube" + # Can help remote software to know this is a PeerTube instance + powered_by_header: + enabled: true + tracker: # If you disable the tracker, you disable the P2P on your PeerTube instance enabled: true @@ -332,6 +374,12 @@ feeds: # Default number of comments displayed in feeds count: 20 +remote_runners: + # Consider jobs that are processed by a remote runner as stalled after this period of time without any update + stalled_jobs: + live: '30 seconds' + vod: '2 minutes' + ############################################################################### # # From this point, almost all following keys can be overridden by the web interface @@ -362,15 +410,25 @@ 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 + + # Users fill a form to register so moderators can accept/reject the registration + requires_approval: true requires_email_verification: false + filters: cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist whitelist: [] blacklist: [] user: + history: + videos: + # Enable or disable video history by default for new users. + enabled: true # 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 @@ -392,12 +450,18 @@ transcoding: # 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 + # Enable remote runners to transcode your videos + # If enabled, your instance won't transcode the videos itself + # At least 1 remote runner must be configured to transcode your videos + remote_runners: + enabled: false + + # Amount of threads used by ffmpeg for 1 local transcoding job threads: 1 - # Amount of transcoding jobs to execute in parallel + # Amount of local transcoding jobs to execute in parallel concurrency: 1 - # Choose the transcoding profile + # Choose the local transcoding profile # New profiles can be added by plugins # Available in core PeerTube: 'default' profile: 'default' @@ -492,9 +556,17 @@ live: # Allow to transcode the live streaming in multiple live resolutions transcoding: enabled: true + + # Enable remote runners to transcode your videos + # If enabled, your instance won't transcode the videos itself + # At least 1 remote runner must be configured to transcode your videos + remote_runners: + enabled: false + + # Amount of threads used by ffmpeg per live when using local transcoding threads: 2 - # Choose the transcoding profile + # Choose the local transcoding profile # New profiles can be added by plugins # Available in core PeerTube: 'default' profile: 'default' @@ -517,6 +589,13 @@ video_studio: # If enabled, users can create transcoding tasks as they wish enabled: false + + # Enable remote runners to transcode studio tasks + # If enabled, your instance won't transcode the videos itself + # At least 1 remote runner must be configured to transcode your videos + remote_runners: + enabled: false + import: # Add ability for your users to import remote videos (from YouTube, torrent...) videos: @@ -529,7 +608,7 @@ import: # 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 + # See https://docs.joinpeertube.org/maintain/configuration#security for more information enabled: false youtube_dl_release: @@ -553,10 +632,10 @@ import: # 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 + # See https://docs.joinpeertube.org/maintain/configuration#security for more information enabled: false - # Add ability for your users to synchronize their channels with external channels, playlists, etc. + # Add ability for your users to synchronize their channels with external channels, playlists, etc video_channel_synchronization: enabled: false @@ -567,6 +646,9 @@ import: # 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: @@ -714,9 +796,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