2018-05-29 10:28:08 +02:00
# /!\ YOU SHOULD NOT UPDATE THIS FILE, USE production.yaml instead /!\ #
2015-06-09 17:41:40 +02:00
listen :
2018-04-17 11:14:32 +02:00
hostname : '127.0.0.1'
2015-06-09 17:41:40 +02:00
port : 9000
2021-01-11 10:09:24 +01:00
# Correspond to your reverse proxy server_name/listen configuration (i.e., your public PeerTube instance URL)
2015-06-09 17:41:40 +02:00
webserver :
https : false
2016-10-23 19:41:17 +02:00
hostname : 'localhost'
2015-06-09 17:41:40 +02:00
port : 9000
2022-10-10 11:12:23 +02:00
# Secrets you need to generate the first time you run PeerTube
secrets :
2022-10-10 11:19:45 +02:00
# Generate one using `openssl rand -hex 32`
2022-10-10 11:12:23 +02:00
peertube : ''
2019-04-26 13:48:55 +02:00
rates_limit :
2019-07-04 16:42:40 +02:00
api :
# 50 attempts in 10 seconds
window : 10 seconds
2021-01-29 14:56:40 +01:00
max : 50
2019-04-26 13:48:55 +02:00
login :
# 15 attempts in 5 min
window : 5 minutes
max : 15
2019-07-04 16:42:40 +02:00
signup :
# 2 attempts in 5 min (only succeeded attempts are taken into account)
window : 5 minutes
max : 2
2019-04-26 13:48:55 +02:00
ask_send_email :
# 3 attempts in 5 min
window : 5 minutes
max : 3
2022-07-15 15:30:14 +02:00
receive_client_log :
# 10 attempts in 10 min
window : 10 minutes
max : 10
2019-04-26 13:48:55 +02:00
2022-12-29 14:18:07 +01:00
oauth2 :
token_lifetime :
access_token : '1 day'
refresh_token : '2 weeks'
2018-03-29 10:58:24 +02:00
# 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)
trust_proxy :
- 'loopback'
2021-10-20 16:14:55 +02:00
# Your database name will be database.name OR 'peertube'+database.suffix
2015-06-09 17:41:40 +02:00
database :
2016-10-23 19:41:17 +02:00
hostname : 'localhost'
2016-12-11 21:50:51 +01:00
port : 5432
2020-08-24 11:38:57 +02:00
ssl : false
2016-12-11 21:50:51 +01:00
suffix : '_dev'
2017-01-04 20:59:23 +01:00
username : 'peertube'
password : 'peertube'
2018-07-28 21:02:26 +02:00
pool :
max : 5
2015-06-09 17:41:40 +02:00
2021-01-29 14:56:40 +01:00
# Redis server for short time storage
2018-05-14 17:51:15 +02:00
# You can also specify a 'socket' path to a unix socket but first need to
2022-04-15 11:56:41 +02:00
# set 'hostname' and 'port' to null
2018-01-25 15:05:18 +01:00
redis :
hostname : 'localhost'
port : 6379
2023-05-10 09:52:50 +02:00
auth : null # Used by both standalone and sentinel
2018-05-21 13:26:04 +02:00
db : 0
2023-05-10 09:52:50 +02:00
sentinel :
enabled : false
enable_tls : false
master_name : ''
sentinels :
- hostname : ''
port : 26379
2018-01-25 15:05:18 +01:00
2021-01-29 14:56:40 +01:00
# SMTP server to send emails
2018-01-30 13:27:07 +01:00
smtp :
2019-02-13 12:16:27 +01:00
# smtp or sendmail
transport : smtp
# Path to sendmail command. Required if you use sendmail transport
sendmail : null
2018-01-30 13:27:07 +01:00
hostname : null
2021-01-29 14:56:40 +01:00
port: 465 # If you use StartTLS : 587
2018-01-30 13:27:07 +01:00
username : null
password : null
2021-01-29 14:56:40 +01:00
tls: true # If you use StartTLS : false
2018-03-22 16:12:52 +01:00
disable_starttls : false
2018-01-30 13:27:07 +01:00
ca_file : null # Used for self signed certificates
from_address : 'admin@example.com'
2019-05-17 14:10:19 +02:00
email :
body :
2021-10-20 16:14:55 +02:00
signature : 'PeerTube'
2019-08-22 10:22:01 +02:00
subject :
2021-10-20 16:14:55 +02:00
prefix : '[PeerTube]'
2019-05-17 14:10:19 +02:00
2021-12-14 17:17:01 +01:00
# 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
2021-10-12 14:23:44 +02:00
2021-12-14 17:17:01 +01:00
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
2021-12-03 17:04:47 +01:00
2021-12-15 15:58:10 +01:00
p2p :
2021-12-16 09:38:27 +01:00
# Enable P2P by default in PeerTube client
2021-12-15 15:58:10 +01:00
# Can be enabled/disabled by anonymous users and logged in users
2021-12-16 09:38:27 +01:00
webapp :
enabled : true
# Enable P2P by default in PeerTube embed
# Can be enabled/disabled by URL option
embed :
enabled : true
2021-12-15 15:58:10 +01:00
2015-06-09 17:41:40 +02:00
# From the project root directory
storage :
2021-06-08 11:45:03 +02:00
tmp : 'storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
2023-05-03 15:17:11 +02:00
tmp_persistent : 'storage/tmp-persistent/' # As tmp but the directory is not cleaned up between PeerTube restarts
2021-10-21 16:28:39 +02:00
bin : 'storage/bin/'
2018-01-15 11:10:46 +01:00
avatars : 'storage/avatars/'
videos : 'storage/videos/'
2019-03-05 12:00:31 +01:00
streaming_playlists : 'storage/streaming-playlists/'
2018-12-04 16:02:49 +01:00
redundancy : 'storage/redundancy/'
2018-01-15 11:10:46 +01:00
logs : 'storage/logs/'
previews : 'storage/previews/'
thumbnails : 'storage/thumbnails/'
torrents : 'storage/torrents/'
2018-07-12 19:02:00 +02:00
captions : 'storage/captions/'
2018-01-15 11:10:46 +01:00
cache : 'storage/cache/'
2019-07-05 13:54:32 +02:00
plugins : 'storage/plugins/'
2022-10-04 10:53:00 +02:00
well_known : 'storage/well-known/'
2021-10-13 08:54:32 +02:00
# Overridable client files in client/dist/assets/images:
2021-10-12 13:50:40 +02:00
# - logo.svg
# - favicon.png
# - default-playlist.jpg
# - default-avatar-account.png
# - default-avatar-video-channel.png
# - and icons/*.png (PWA)
2020-07-10 10:20:11 +02:00
# Could contain for example assets/images/favicon.png
# If the file exists, peertube will serve it
2021-10-13 08:54:32 +02:00
# If not, peertube will fallback to the default file
2020-07-10 10:20:11 +02:00
client_overrides : 'storage/client-overrides/'
2017-07-12 11:56:02 +02:00
2022-10-26 16:23:39 +02:00
static_files :
# Require and check user authentication when accessing private files (internal/private video files)
private_files_require_auth : true
2021-08-17 08:26:20 +02:00
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'
2022-10-19 10:43:53 +02:00
upload_acl :
# Set this ACL on each uploaded object of public/unlisted videos
2023-01-12 08:41:16 +01:00
# Use null if your S3 provider does not support object ACL
2022-10-19 10:43:53 +02:00
public : 'public-read'
2022-10-26 16:23:39 +02:00
# Set this ACL on each uploaded object of private/internal videos
# PeerTube can proxify requests to private objects so your users can access them
2023-01-12 08:41:16 +01:00
# Use null if your S3 provider does not support object ACL
2022-10-19 10:43:53 +02:00
private : 'private'
2022-03-15 16:57:12 +01:00
2022-10-26 16:23:39 +02:00
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
2021-08-17 08:26:20 +02:00
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
2022-09-08 08:54:12 +02:00
max_upload_part : 100MB
2021-08-17 08:26:20 +02:00
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 : ''
2018-01-19 13:58:13 +01:00
log :
2021-05-25 10:08:29 +02:00
level : 'info' # 'debug' | 'info' | 'warn' | 'error'
2022-07-15 15:30:14 +02:00
2019-06-11 14:30:44 +02:00
rotation :
2021-01-29 14:56:40 +01:00
enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
2021-10-20 16:14:55 +02:00
max_file_size : 12MB
max_files : 20
2022-07-15 15:30:14 +02:00
2021-10-20 16:14:55 +02:00
anonymize_ip : false
2022-07-15 15:30:14 +02:00
2021-01-07 22:52:37 +01:00
log_ping_requests : true
2022-06-30 09:13:11 +02:00
log_tracker_unknown_infohash : true
2022-07-15 15:30:14 +02:00
2021-01-26 09:54:32 +01:00
prettify_sql : false
2018-01-19 13:58:13 +01:00
2022-07-15 15:30:14 +02:00
# Accept warn/error logs coming from the client
accept_client_log : true
2022-11-15 13:56:04 +01:00
# Support of Open Telemetry metrics and tracing
2023-02-22 16:15:14 +01:00
# For more information: https://docs.joinpeertube.org/maintain/observability
2022-07-05 15:43:21 +02:00
open_telemetry :
metrics :
enabled : false
2023-02-27 13:53:54 +01:00
http_request_duration :
# You can disable HTTP request duration metric that can have a high tag cardinality
enabled : true
2022-07-05 15:43:21 +02:00
# Create a prometheus exporter server on this port so prometheus server can scrape PeerTube metrics
prometheus_exporter :
2022-11-15 13:56:04 +01:00
hostname : '127.0.0.1'
2022-07-05 15:43:21 +02:00
port : 9091
tracing :
enabled : false
# Send traces to a Jaeger compatible endpoint
jaeger_exporter :
endpoint : ''
2018-08-31 17:18:13 +02:00
trending :
videos :
2023-02-20 10:17:03 +01:00
interval_days : 7 # Compute trending videos for the last x days for 'most-viewed' algorithm
2021-01-27 17:15:21 +01:00
algorithms :
enabled :
2023-02-20 10:17:03 +01:00
- '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
2021-01-27 17:15:21 +01:00
default : 'most-viewed'
2018-08-31 17:18:13 +02:00
2018-09-11 16:27:07 +02:00
# Cache remote videos on your server, to help other instances to broadcast the video
# You can define multiple caches using different sizes/strategies
# Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
redundancy :
videos :
2018-09-19 16:21:09 +02:00
check_interval : '1 hour' # How often you want to check new videos to cache
2018-12-04 16:02:49 +01:00
strategies : # Just uncomment strategies you want
2018-09-19 16:12:07 +02:00
# -
# size: '10GB'
2018-09-24 13:07:33 +02:00
# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
# min_lifetime: '48 hours'
2018-09-19 16:12:07 +02:00
# strategy: 'most-views' # Cache videos that have the most views
# -
# size: '10GB'
2018-09-24 13:07:33 +02:00
# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
# min_lifetime: '48 hours'
2018-09-19 16:12:07 +02:00
# strategy: 'trending' # Cache trending videos
# -
# size: '10GB'
2018-09-24 13:07:33 +02:00
# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
# min_lifetime: '48 hours'
2018-09-19 16:12:07 +02:00
# strategy: 'recently-added' # Cache recently added videos
2018-09-24 13:07:33 +02:00
# min_views: 10 # Having at least x views
2018-09-11 16:27:07 +02:00
2020-04-07 15:27:41 +02:00
# Other instances that duplicate your content
remote_redundancy :
videos :
# 'nobody': Do not accept remote redundancies
# 'anybody': Accept remote redundancies from anybody
# 'followings': Accept redundancies from instance followings
accept_from : 'anybody'
2019-02-21 16:27:32 +01:00
csp :
enabled : false
report_only : true # CSP directives are still being tested, so disable the report only mode at your own risk!
report_uri :
2021-04-12 15:33:54 +02:00
security :
# Set the X-Frame-Options header to help to mitigate clickjacking attacks
frameguard :
enabled : true
2023-02-27 09:22:59 +01:00
# Set x-powered-by HTTP header to "PeerTube"
# Can help remote software to know this is a PeerTube instance
powered_by_header :
enabled : true
2019-04-10 09:23:18 +02:00
tracker :
2021-12-15 15:58:10 +01:00
# If you disable the tracker, you disable the P2P on your PeerTube instance
2019-04-10 09:23:18 +02:00
enabled : true
2021-10-22 13:56:45 +02:00
# Only handle requests on your videos
# If you set this to false it means you have a public tracker
2019-04-10 09:23:18 +02:00
# 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)
reject_too_many_announces : false
2019-04-11 15:38:53 +02:00
history :
videos :
# If you want to limit users videos history
# -1 means there is no limitations
# Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
max_age : -1
2019-04-11 17:33:36 +02:00
views :
videos :
# PeerTube creates a database entry every hour for each video to track views over a period of time
# This is used in particular by the Trending page
# PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
# -1 means no cleanup
# Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
remote :
2020-11-27 14:02:25 +01:00
max_age : '30 days'
2019-04-11 17:33:36 +02:00
2021-11-09 10:11:20 +01:00
# PeerTube buffers local video views before updating and federating the video
local_buffer_update_interval : '30 minutes'
ip_view_expiration : '1 hour'
2022-03-24 13:36:47 +01:00
# 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'
2019-07-16 11:33:22 +02:00
plugins :
2019-07-16 15:03:00 +02:00
# The website PeerTube will ask for available PeerTube plugins and themes
# This is an unmoderated plugin index, so only install plugins/themes you trust
2019-07-16 11:33:22 +02:00
index :
enabled : true
2019-07-30 10:18:23 +02:00
check_latest_versions_interval : '12 hours' # How often you want to check new plugins/themes versions
2019-07-16 11:33:22 +02:00
url : 'https://packages.joinpeertube.org'
2020-06-03 09:42:07 +02:00
federation :
videos :
2020-11-10 14:22:13 +01:00
federate_unlisted : false
2020-06-03 09:42:07 +02:00
2021-02-26 16:26:27 +01:00
# 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
2021-11-29 15:33:08 +01:00
cleanup_remote_interactions : true
2021-02-26 16:26:27 +01:00
2021-03-11 16:54:52 +01:00
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'
2021-10-12 13:33:44 +02:00
webadmin :
configuration :
2021-10-14 11:35:43 +02:00
edition :
2021-10-14 09:37:01 +02:00
# Set this to false if you don't want to allow config edition in the web interface by instance admins
2021-10-12 13:33:44 +02:00
allowed : true
2022-05-24 15:56:23 +02:00
# 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
2023-04-21 14:55:10 +02:00
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'
2017-07-12 11:56:02 +02:00
cache :
previews :
2018-07-25 15:11:06 +02:00
size : 500 # Max number of previews you want to cache
2018-07-12 19:02:00 +02:00
captions :
2018-07-25 15:11:06 +02:00
size : 500 # Max number of video captions/subtitles you want to cache
2021-02-16 16:25:53 +01:00
torrents :
size : 500 # Max number of video torrents you want to cache
2017-02-16 19:19:56 +01:00
admin :
2019-01-09 15:14:29 +01:00
# Used to generate the root user at first startup
# And to receive emails from the contact form
email : 'admin@example.com'
contact_form :
enabled : true
2017-03-10 11:32:39 +01:00
signup :
enabled : false
2023-01-19 09:27:16 +01:00
2017-07-25 20:17:28 +02:00
limit : 10 # When the limit is reached, registrations are disabled. -1 == unlimited
2023-01-19 09:27:16 +01:00
2021-04-24 11:57:01 +02:00
minimum_age : 16 # Used to configure the signup form
2023-01-19 09:27:16 +01:00
# Users fill a form to register so moderators can accept/reject the registration
requires_approval : true
2018-08-31 09:18:19 +02:00
requires_email_verification : false
2023-01-19 09:27:16 +01:00
2018-05-29 10:28:08 +02:00
filters :
2018-05-22 19:43:13 +02:00
cidr : # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
whitelist : [ ]
blacklist : [ ]
2017-05-02 22:02:27 +02:00
2017-09-04 20:07:54 +02:00
user :
2023-04-07 10:09:54 +02:00
history :
videos :
# Enable or disable video history by default for new users.
enabled : true
2021-10-22 13:56:45 +02:00
# Default value of maximum video bytes the user can upload (does not take into account transcoded files)
# Byte format is supported ("1GB" etc)
2017-09-04 20:07:54 +02:00
# -1 == unlimited
video_quota : -1
2018-08-28 09:01:35 +02:00
video_quota_daily : -1
2017-09-04 20:07:54 +02:00
2021-10-26 16:42:10 +02:00
video_channels :
max_per_user : 20 # Allows each user to create up to 20 video channels.
2021-10-20 16:14:55 +02:00
# If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
2021-10-22 13:56:45 +02:00
# In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions
2018-06-07 16:44:22 +02:00
# Please, do not disable transcoding since many uploaded videos will not work
2017-05-02 22:02:27 +02:00
transcoding :
2018-02-26 10:00:44 +01:00
enabled : true
2021-01-28 15:52:44 +01:00
2020-08-04 15:48:09 +02:00
# Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
2018-12-11 14:52:50 +01:00
allow_additional_extensions : true
2021-01-28 15:52:44 +01:00
2019-05-16 16:55:34 +02:00
# 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
2021-01-28 15:52:44 +01:00
2023-04-21 14:55:10 +02:00
# 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
2018-02-26 12:12:35 +01:00
threads : 1
2023-04-21 14:55:10 +02:00
# Amount of local transcoding jobs to execute in parallel
2021-02-08 10:51:10 +01:00
concurrency : 1
2021-01-28 15:52:44 +01:00
2023-04-21 14:55:10 +02:00
# Choose the local transcoding profile
2021-01-28 15:52:44 +01:00
# New profiles can be added by plugins
# Available in core PeerTube: 'default'
profile : 'default'
2018-06-07 16:44:22 +02:00
resolutions : # Only created if the original video has a higher resolution, uses more storage!
2019-11-03 18:29:10 +01:00
0p : false # audio-only (creates mp4 without video stream, always created when enabled)
2021-11-05 10:23:02 +01:00
144p : false
2018-02-26 10:00:44 +01:00
240p : false
360p : false
480p : false
720p : false
1080p : false
2020-12-24 18:02:04 +01:00
1440p : false
2019-06-06 14:45:57 +02:00
2160p : false
2019-11-15 15:06:03 +01:00
2022-08-05 10:36:19 +02:00
# Transcode and keep original resolution, even if it's above your maximum enabled resolution
always_transcode_original_resolution : true
2019-11-15 15:06:03 +01:00
# 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
2020-01-06 16:43:15 +01:00
# If disabled, breaks federation with PeerTube instances < 2.1
2019-11-15 15:06:03 +01:00
webtorrent :
2021-04-06 08:41:18 +02:00
enabled : false
2019-11-15 15:06:03 +01:00
2019-11-05 10:13:37 +01:00
# /!\ Requires ffmpeg >= 4.1
2019-02-11 17:20:28 +01:00
# Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
2019-01-29 08:37:25 +01:00
# * Resolution change is smoother
# * Faster playback in particular with long videos
# * More stable playback (less bugs/infinite loading)
2019-11-15 15:06:03 +01:00
# If you also enabled the webtorrent format, it will multiply videos storage by 2
2019-01-29 08:37:25 +01:00
hls :
2021-04-06 08:41:18 +02:00
enabled : true
2018-01-31 16:42:40 +01:00
2020-09-17 09:20:52 +02:00
live :
enabled : false
2020-09-25 10:04:21 +02:00
# Limit lives duration
2020-12-15 09:23:28 +01:00
# -1 == unlimited
max_duration: -1 # For example : '5 hours'
2020-09-25 10:04:21 +02:00
2020-10-28 15:24:40 +01:00
# 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
2020-09-25 10:04:21 +02:00
# 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
2021-01-29 14:56:40 +01:00
allow_replay : true
2020-09-25 10:04:21 +02:00
2022-03-04 13:40:02 +01:00
# 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
2021-01-11 09:20:44 +01:00
# Your firewall should accept traffic from this port in TCP if you enable live
2020-09-17 09:20:52 +02:00
rtmp :
2021-11-05 11:36:03 +01:00
enabled : true
2022-05-02 14:32:12 +02:00
2022-05-04 09:10:25 +02:00
# Listening hostname/port for RTMP server
2022-05-04 16:12:49 +02:00
# '::' 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
2022-05-02 14:32:12 +02:00
port : 1935
2022-05-04 09:10:25 +02:00
# Public hostname of your RTMP server
2022-05-02 14:32:12 +02:00
# Use null to use the same value than `webserver.hostname`
public_hostname : null
2020-09-17 09:20:52 +02:00
2021-11-05 11:36:03 +01:00
rtmps :
enabled : false
2022-05-02 14:32:12 +02:00
2022-05-04 09:10:25 +02:00
# Listening hostname/port for RTMPS server
2022-05-04 16:12:49 +02:00
# '::' 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
2021-11-05 11:36:03 +01:00
port : 1936
2022-05-02 14:32:12 +02:00
# Absolute paths
2021-11-05 11:36:03 +01:00
key_file : ''
cert_file : ''
2022-05-02 14:32:12 +02:00
2022-05-04 09:10:25 +02:00
# Public hostname of your RTMPS server
2022-05-02 14:32:12 +02:00
# Use null to use the same value than `webserver.hostname`
public_hostname : null
2021-11-05 11:36:03 +01:00
2020-09-25 10:04:21 +02:00
# Allow to transcode the live streaming in multiple live resolutions
2020-09-17 09:20:52 +02:00
transcoding :
2020-12-01 10:29:03 +01:00
enabled : true
2023-04-21 14:55:10 +02:00
# 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
2020-09-17 09:20:52 +02:00
threads : 2
2023-04-21 14:55:10 +02:00
# Choose the local transcoding profile
2021-01-28 15:52:44 +01:00
# New profiles can be added by plugins
# Available in core PeerTube: 'default'
profile : 'default'
2020-09-17 09:20:52 +02:00
resolutions :
2021-11-05 10:23:02 +01:00
144p : false
2020-09-17 09:20:52 +02:00
240p : false
360p : false
480p : false
720p : false
1080p : false
2020-12-24 18:02:04 +01:00
1440p : false
2020-09-17 09:20:52 +02:00
2160p : false
2022-08-05 10:36:19 +02:00
# Also transcode original resolution, even if it's above your maximum enabled resolution
always_transcode_original_resolution : true
2022-03-22 16:58:49 +01:00
video_studio :
2022-02-11 10:51:33 +01:00
# Enable video edition by users (cut, add intro/outro, add watermark etc)
2022-05-23 09:25:40 +02:00
# If enabled, users can create transcoding tasks as they wish
2022-02-11 10:51:33 +01:00
enabled : false
2023-05-04 15:29:34 +02:00
# 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
2018-08-02 15:34:09 +02:00
import :
# Add ability for your users to import remote videos (from YouTube, torrent...)
videos :
2021-02-08 10:51:10 +01:00
# Amount of import jobs to execute in parallel
concurrency : 1
2022-05-24 14:55:07 +02:00
# Set a custom video import timeout to not block import queue
timeout : '2 hours'
2022-02-09 08:58:40 +01:00
# 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
2023-02-23 09:46:43 +01:00
# See https://docs.joinpeertube.org/maintain/configuration#security for more information
2018-08-03 11:10:31 +02:00
enabled : false
2020-11-18 14:11:15 +01:00
2021-10-21 16:28:39 +02:00
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
2022-07-06 16:15:47 +02:00
# * https://yt-dl.org/downloads/latest/youtube-dl
url : 'https://api.github.com/repos/yt-dlp/yt-dlp/releases'
2021-10-21 16:28:39 +02:00
2022-07-06 16:15:47 +02:00
# Release binary name: 'yt-dlp' or 'youtube-dl'
name : 'yt-dlp'
2021-10-21 16:28:39 +02:00
2022-01-09 17:21:45 +01:00
# Path to the python binary to execute for youtube-dl or yt-dlp
python_path : '/usr/bin/python3'
2020-11-18 14:06:20 +01:00
# IPv6 is very strongly rate-limited on most sites supported by youtube-dl
2020-11-18 14:11:15 +01:00
force_ipv4 : false
2022-02-09 08:58:40 +01:00
# 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
2023-02-23 09:46:43 +01:00
# See https://docs.joinpeertube.org/maintain/configuration#security for more information
2018-08-07 10:07:53 +02:00
enabled : false
2018-08-02 15:34:09 +02:00
2022-08-10 09:53:39 +02:00
# 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
2022-11-14 11:11:39 +01:00
# Max number of videos to import when the user asks for full sync
full_sync_videos_limit : 1000
2019-04-02 11:26:47 +02:00
auto_blacklist :
# New videos automatically blacklisted so moderators can review before publishing
videos :
of_users :
enabled : false
2021-01-29 14:56:40 +01:00
# Instance settings
2018-01-31 16:42:40 +01:00
instance :
name : 'PeerTube'
2020-03-08 17:33:40 +01:00
short_description : 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
2018-02-09 09:44:38 +01:00
description : 'Welcome to this PeerTube instance!' # Support markdown
terms : 'No terms for now.' # Support markdown
2019-08-23 15:23:27 +02:00
code_of_conduct : '' # Supports markdown
# Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
moderation_information : '' # Supports markdown
2019-09-03 09:49:04 +02:00
# Why did you create this instance?
2020-11-30 15:08:01 +01:00
creation_reason : '' # Supports Markdown
2019-09-03 09:49:04 +02:00
2019-08-23 15:23:27 +02:00
# Who is behind the instance? A single person? A non profit?
2020-11-30 15:08:01 +01:00
administrator : '' # Supports Markdown
2019-08-23 15:23:27 +02:00
# How long do you plan to maintain this instance?
2020-11-30 15:08:01 +01:00
maintenance_lifetime : '' # Supports Markdown
2019-08-23 15:23:27 +02:00
2020-01-15 12:15:31 +01:00
# How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
2020-11-30 15:08:01 +01:00
business_model : '' # Supports Markdown
2019-08-23 15:23:27 +02:00
2019-09-05 09:43:35 +02:00
# If you want to explain on what type of hardware your PeerTube instance runs
2021-10-20 16:14:55 +02:00
# Example: '2 vCore, 2GB RAM...'
2019-09-05 09:43:35 +02:00
hardware_information : '' # Supports Markdown
2019-08-23 15:23:27 +02:00
# What are the main languages of your instance? To interact with your users for example
# Uncomment or add the languages you want
# List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
languages :
# - en
# - es
# - fr
# You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
# Uncomment or add the category ids you want
# List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
categories :
# - 1 # Music
# - 2 # Films
# - 3 # Vehicles
# - 4 # Art
# - 5 # Sports
# - 6 # Travels
# - 7 # Gaming
# - 8 # People
# - 9 # Comedy
# - 10 # Entertainment
# - 11 # News & Politics
# - 12 # How To
# - 13 # Education
# - 14 # Activism
# - 15 # Science & Technology
# - 16 # Animals
# - 17 # Kids
# - 18 # Food
2018-03-01 13:57:29 +01:00
default_client_route : '/videos/trending'
2019-08-23 15:23:27 +02:00
2019-02-20 15:36:43 +01:00
# 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
2021-10-20 16:14:55 +02:00
# By default, `do_not_list` or `blur` or `display` NSFW videos
2018-04-19 11:01:34 +02:00
# Could be overridden per user with a setting
default_nsfw_policy : 'do_not_list'
2019-08-23 15:23:27 +02:00
2018-02-22 10:22:53 +01:00
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
2021-10-20 16:14:55 +02:00
# Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
2018-05-15 00:29:40 +02:00
robots : |
User-agent : *
2018-09-18 11:18:51 +02:00
Disallow :
2022-09-22 08:54:57 +02:00
# /.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
2018-09-06 14:23:46 +02:00
securitytxt :
2021-10-20 16:14:55 +02:00
'# 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:'
2018-05-10 12:26:47 +02:00
services :
# Cards configuration to format video in Twitter
twitter :
2018-05-31 11:04:34 +02:00
username : '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
2018-05-10 12:26:47 +02:00
# 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
2021-10-20 16:14:55 +02:00
# Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
2018-05-10 12:26:47 +02:00
whitelisted : false
2019-04-08 14:04:57 +02:00
followers :
instance :
# Allow or not other instances to follow yours
enabled : true
2019-04-08 15:18:04 +02:00
# Whether or not an administrator must manually validate a new follower
manual_approval : false
2019-07-09 11:45:19 +02:00
2019-08-30 16:50:12 +02:00
followings :
instance :
# If you want to automatically follow back new instance followers
# If this option is enabled, use the mute feature instead of deleting followings
# /!\ Don't enable this if you don't have a reactive moderation team /!\
auto_follow_back :
enabled : false
# If you want to automatically follow instances of the public index
# If this option is enabled, use the mute feature instead of deleting followings
# /!\ Don't enable this if you don't have a reactive moderation team /!\
auto_follow_index :
enabled : false
2020-05-11 10:48:58 +02:00
# Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
index_url : ''
2019-08-30 16:50:12 +02:00
2019-07-09 11:45:19 +02:00
theme :
default : 'default'
2020-05-28 11:15:38 +02:00
broadcast_message :
enabled : false
message : '' # Support markdown
2021-05-25 10:08:29 +02:00
level : 'info' # 'info' | 'warning' | 'error'
2020-05-28 11:15:38 +02:00
dismissable : false
2020-05-29 16:16:24 +02:00
search :
# Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
# If enabled, the associated group will be able to "escape" from the instance follows
# That means they will be able to follow channels, watch videos, list videos of non followed instances
remote_uri :
users : true
anonymous : false
# Use a third party index instead of your local index, only for search results
# Useful to discover content outside of your instance
# If you enable search_index, you must enable remote_uri search for users
# If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
# instead of loading the video locally
search_index :
enabled : false
# URL of the search index, that should use the same search API and routes
2023-04-21 14:55:10 +02:00
# than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
2020-05-29 16:16:24 +02:00
# 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 : ''
2022-11-23 15:50:34 +01:00
# You can disable local search in the client, so users only use the search index
2020-05-29 16:16:24 +02:00
disable_local_search : false
2022-11-23 15:50:34 +01:00
# If you did not disable local search in the client, you can decide to use the search index by default
2020-05-29 16:16:24 +02:00
is_default_search : false
2021-12-14 17:17:01 +01:00
# PeerTube client/interface configuration
client :
videos :
miniature :
# By default PeerTube client displays author username
prefer_author_display_name : false
2022-03-08 13:39:27 +01:00
display_author_avatar : false
2022-03-16 10:57:36 +01:00
resumable_upload :
# Max size of upload chunks, e.g. '90MB'
# If null, it will be calculated based on network speed
max_chunk_size : null
2021-12-14 17:17:01 +01:00
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