listen:
- hostname: 'localhost'
+ hostname: '127.0.0.1'
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'
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
# 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'
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
+ ssl: false
suffix: '_prod'
username: 'peertube'
password: 'peertube'
# 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
+ auth: null # Used by both standalone and sentinel
db: 0
+ sentinel:
+ enabled: false
+ enable_tls: false
+ master_name: ''
+ sentinels:
+ - hostname: ''
+ port: 26379
# SMTP server to send emails
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 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: '/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...
+ 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/'
streaming_playlists: '/var/www/peertube/storage/streaming-playlists/'
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
+ # - 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 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
+
+ # Without protocol, will default to HTTPS
+ endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
+
+ region: 'us-east-1'
+
+ 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
+ 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: 100MB
+
+ 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
+ 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
+
+ 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:
+ 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
+ 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' # 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
# You can define multiple caches using different sizes/strategies
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
+
+ # 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 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)
# -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'
+
+ # 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
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
+ 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
+
+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, all the following keys can be overridden by the web interface
+# From this point, almost all 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 /!\.
+# /!\ If you already have a local-production.json file, modification of some of
+# the following keys will have no effect /!\
#
###############################################################################
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
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:
- # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
+ 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
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, .flv videos
+
+ # 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
+
+ # 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 local transcoding jobs to execute in parallel
+ concurrency: 1
+
+ # Choose the local 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
720p: false
1080p: false
+ 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
webtorrent:
- enabled: true
+ enabled: false
# /!\ Requires ffmpeg >= 4.1
# Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
# * More stable playback (less bugs/infinite loading)
# If you also enabled the webtorrent format, it will multiply videos storage by 2
hls:
+ 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
+
+ # 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
+
+ # 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 local 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
+ 720p: false
+ 1080p: false
+ 1440p: false
+ 2160p: false
+
+ # 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
+
+
+ # 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:
- 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#security for more information
enabled: 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)
+
+ 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
+ # * https://yt-dl.org/downloads/latest/youtube-dl
+ url: 'https://api.github.com/repos/yt-dlp/yt-dlp/releases'
+
+ # 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'
+
+ # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
+ force_ipv4: false
+
+ # 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#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:
# 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
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..."
+ # Example: '2 vCore, 2GB RAM...'
hardware_information: '' # Supports Markdown
# What are the main languages of your instance? To interact with your users for example
# 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 <script> tags). Will be eval at runtime
css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
- # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
+ # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
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:"
+ '# 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:'
services:
# Cards configuration to format video in Twitter
username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
# If true, a video player will be embedded in the Twitter feed on PeerTube video share
# If false, we use an image link card that will redirect on your PeerTube instance
- # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
+ # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
whitelisted: false
followers:
# 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
+client:
+ videos:
+ miniature:
+ # By default PeerTube client displays author username
+ prefer_author_display_name: false
+ display_author_avatar: false
+ resumable_upload:
+ # Max size of upload chunks, e.g. '90MB'
+ # If null, it will be calculated based on network speed
+ max_chunk_size: null
+
+ menu:
+ login:
+ # If you enable only one external auth plugin
+ # You can automatically redirect your users on this external platform when they click on the login button
+ redirect_on_single_external_auth: false
projects / github / Chocobozzz / PeerTube.git / blobdiff