]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - config/production.yaml.example
Bumped to version v5.2.1
[github/Chocobozzz/PeerTube.git] / config / production.yaml.example
CommitLineData
552cc9d6 1listen:
a4152bed 2 hostname: '127.0.0.1'
552cc9d6
C
3 port: 9000
4
d8658f0f 5# Correspond to your reverse proxy server_name/listen configuration (i.e., your public PeerTube instance URL)
f1f4732f 6webserver:
d478d83d 7 https: true
3737bbaf 8 hostname: 'example.com'
d478d83d 9 port: 443
825a5d9c 10
a3e5f804 11# Secrets you need to generate the first time you run PeerTube
dce2aba1 12secrets:
1ea868a9 13 # Generate one using `openssl rand -hex 32`
a3e5f804
C
14 peertube: ''
15
c342726a 16rates_limit:
c1340a6a
C
17 api:
18 # 50 attempts in 10 seconds
19 window: 10 seconds
20 max: 50
c342726a
YB
21 login:
22 # 15 attempts in 5 min
23 window: 5 minutes
24 max: 15
c1340a6a
C
25 signup:
26 # 2 attempts in 5 min (only succeeded attempts are taken into account)
27 window: 5 minutes
28 max: 2
c342726a
YB
29 ask_send_email:
30 # 3 attempts in 5 min
31 window: 5 minutes
32 max: 3
42b40636
C
33 receive_client_log:
34 # 10 attempts in 10 min
35 window: 10 minutes
36 max: 10
c342726a 37
b65f5367
C
38oauth2:
39 token_lifetime:
40 access_token: '1 day'
41 refresh_token: '2 weeks'
42
490b595a
C
43# Proxies to trust to get real client IP
44# If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
45# If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
46trust_proxy:
47 - 'loopback'
48
97b6428a 49# Your database name will be database.name OR 'peertube'+database.suffix
825a5d9c 50database:
552cc9d6
C
51 hostname: 'localhost'
52 port: 5432
b0ce7c39 53 ssl: false
feb4bdfd 54 suffix: '_prod'
6c05c149
C
55 username: 'peertube'
56 password: 'peertube'
1c3386e8
RK
57 pool:
58 max: 5
552cc9d6 59
95540ed2 60# Redis server for short time storage
19f7b248 61# You can also specify a 'socket' path to a unix socket but first need to
ec2fa0d0 62# set 'hostname' and 'port' to null
94a5ff8a
C
63redis:
64 hostname: 'localhost'
65 port: 6379
674f8ddd 66 auth: null # Used by both standalone and sentinel
30c82f0d 67 db: 0
674f8ddd 68 sentinel:
69 enabled: false
70 enable_tls: false
71 master_name: ''
72 sentinels:
73 - hostname: ''
74 port: 26379
94a5ff8a 75
95540ed2 76# SMTP server to send emails
ecb4e35f 77smtp:
ed3f089c
IB
78 # smtp or sendmail
79 transport: smtp
80 # Path to sendmail command. Required if you use sendmail transport
81 sendmail: null
ecb4e35f 82 hostname: null
6401417d 83 port: 465 # If you use StartTLS: 587
ecb4e35f
C
84 username: null
85 password: null
6401417d 86 tls: true # If you use StartTLS: false
bebf2d89 87 disable_starttls: false
ecb4e35f
C
88 ca_file: null # Used for self signed certificates
89 from_address: 'admin@example.com'
90
dd2c2a52
C
91email:
92 body:
97b6428a 93 signature: 'PeerTube'
916937d7 94 subject:
97b6428a 95 prefix: '[PeerTube]'
dd2c2a52 96
3cf68b86
C
97# Update default PeerTube values
98# Set by API when the field is not provided and put as default value in client
99defaults:
100 # Change default values when publishing a video (upload/import/go Live)
101 publish:
102 download_enabled: true
7399a79f 103
3cf68b86
C
104 comments_enabled: true
105
106 # public = 1, unlisted = 2, private = 3, internal = 4
107 privacy: 1
108
109 # CC-BY = 1, CC-SA = 2, CC-ND = 3, CC-NC = 4, CC-NC-SA = 5, CC-NC-ND = 6, Public Domain = 7
110 # You can also choose a custom licence value added by a plugin
111 # No licence by default
112 licence: null
0bc53e20 113
a9bfa85d 114 p2p:
a4152bed 115 # Enable P2P by default in PeerTube client
a9bfa85d 116 # Can be enabled/disabled by anonymous users and logged in users
b65de1be
C
117 webapp:
118 enabled: true
119
a4152bed
C
120 # Enable P2P by default in PeerTube embed
121 # Can be enabled/disabled by URL option
b65de1be
C
122 embed:
123 enabled: true
a9bfa85d 124
552cc9d6
C
125# From the project root directory
126storage:
37ede348 127 tmp: '/var/www/peertube/storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
6a490560 128 tmp_persistent: '/var/www/peertube/storage/tmp-persistent/' # As tmp but the directory is not cleaned up between PeerTube restarts
62549e6c 129 bin: '/var/www/peertube/storage/bin/'
59c48d49
C
130 avatars: '/var/www/peertube/storage/avatars/'
131 videos: '/var/www/peertube/storage/videos/'
0b16f5f2 132 streaming_playlists: '/var/www/peertube/storage/streaming-playlists/'
aafbc63a 133 redundancy: '/var/www/peertube/storage/redundancy/'
59c48d49
C
134 logs: '/var/www/peertube/storage/logs/'
135 previews: '/var/www/peertube/storage/previews/'
136 thumbnails: '/var/www/peertube/storage/thumbnails/'
137 torrents: '/var/www/peertube/storage/torrents/'
40e87e9e 138 captions: '/var/www/peertube/storage/captions/'
59c48d49 139 cache: '/var/www/peertube/storage/cache/'
345da516 140 plugins: '/var/www/peertube/storage/plugins/'
6c5f0d3a 141 well_known: '/var/www/peertube/storage/well-known/'
94fecbc1 142 # Overridable client files in client/dist/assets/images:
c80e458a 143 # - logo.svg
144 # - favicon.png
145 # - default-playlist.jpg
146 # - default-avatar-account.png
147 # - default-avatar-video-channel.png
148 # - and icons/*.png (PWA)
caf2aaf4
K
149 # Could contain for example assets/images/favicon.png
150 # If the file exists, peertube will serve it
863c1bc6 151 # If not, peertube will fallback to the default file
caf2aaf4 152 client_overrides: '/var/www/peertube/storage/client-overrides/'
4793c343 153
1ebe2c2b
C
154static_files:
155 # Require and check user authentication when accessing private files (internal/private video files)
156 private_files_require_auth: true
157
0305db28
JB
158object_storage:
159 enabled: false
160
161 # Without protocol, will default to HTTPS
162 endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
163
164 region: 'us-east-1'
165
9ab330b9
C
166 upload_acl:
167 # Set this ACL on each uploaded object of public/unlisted videos
8180f604 168 # Use null if your S3 provider does not support object ACL
9ab330b9 169 public: 'public-read'
1ebe2c2b
C
170 # Set this ACL on each uploaded object of private/internal videos
171 # PeerTube can proxify requests to private objects so your users can access them
8180f604 172 # Use null if your S3 provider does not support object ACL
9ab330b9 173 private: 'private'
f9915efa 174
1ebe2c2b
C
175 proxy:
176 # If private files (private/internal video files) have a private ACL, users can't access directly the ressource
177 # PeerTube can proxify requests between your object storage service and your users
178 # If you disable PeerTube proxy, ensure you use your own proxy that is able to access the private files
179 # Or you can also set a public ACL for private files in object storage if you don't want to use a proxy
180 proxify_private_files: true
181
0305db28
JB
182 credentials:
183 # You can also use AWS_ACCESS_KEY_ID env variable
184 access_key_id: ''
185 # You can also use AWS_SECRET_ACCESS_KEY env variable
186 secret_access_key: ''
187
188 # Maximum amount to upload in one request to object storage
23c0b67d 189 max_upload_part: 100MB
0305db28
JB
190
191 streaming_playlists:
192 bucket_name: 'streaming-playlists'
193
194 # Allows setting all buckets to the same value but with a different prefix
195 prefix: '' # Example: 'streaming-playlists:'
196
197 # Base url for object URL generation, scheme and host will be replaced by this URL
198 # Useful when you want to use a CDN/external proxy
199 base_url: '' # Example: 'https://mirror.example.com'
200
201 # Same settings but for webtorrent videos
202 videos:
203 bucket_name: 'videos'
204 prefix: ''
205 base_url: ''
206
23e27dd5 207log:
31a91119 208 level: 'info' # 'debug' | 'info' | 'warn' | 'error'
42b40636 209
fcf4569f 210 rotation:
aafbc63a 211 enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
97b6428a
C
212 max_file_size: 12MB
213 max_files: 20
42b40636 214
97b6428a 215 anonymize_ip: false
42b40636 216
12c1e38d 217 log_ping_requests: true
a4152bed 218 log_tracker_unknown_infohash: true
42b40636 219
1e743faa 220 prettify_sql: false
23e27dd5 221
42b40636
C
222 # Accept warn/error logs coming from the client
223 accept_client_log: true
224
31a9ed96 225# Support of Open Telemetry metrics and tracing
c5c95361 226# For more information: https://docs.joinpeertube.org/maintain/observability
630d0a1b
C
227open_telemetry:
228 metrics:
229 enabled: false
230
8d1f7804
C
231 http_request_duration:
232 # You can disable HTTP request duration metric that can have a high tag cardinality
233 enabled: true
234
630d0a1b
C
235 # Create a prometheus exporter server on this port so prometheus server can scrape PeerTube metrics
236 prometheus_exporter:
31a9ed96 237 hostname: '127.0.0.1'
630d0a1b
C
238 port: 9091
239
240 tracing:
241 enabled: false
242
243 # Send traces to a Jaeger compatible endpoint
244 jaeger_exporter:
245 endpoint: ''
246
9a629c6e
C
247trending:
248 videos:
15825ef1
C
249 interval_days: 7 # Compute trending videos for the last x days for 'most-viewed' algorithm
250
ba5d4a84
RK
251 algorithms:
252 enabled:
15825ef1
C
253 - 'hot' # Adaptation of Reddit's 'Hot' algorithm
254 - 'most-viewed' # Number of views in the last x days
255 - 'most-liked' # Global views since the upload of the video
256
ba5d4a84 257 default: 'most-viewed'
9a629c6e 258
c48e82b5
C
259# Cache remote videos on your server, to help other instances to broadcast the video
260# You can define multiple caches using different sizes/strategies
261# Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
262redundancy:
263 videos:
f9f899b9 264 check_interval: '1 hour' # How often you want to check new videos to cache
6040f87d 265 strategies: # Just uncomment strategies you want
d9bdd007
C
266# -
267# size: '10GB'
e5565833
C
268# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
269# min_lifetime: '48 hours'
d9bdd007
C
270# strategy: 'most-views' # Cache videos that have the most views
271# -
272# size: '10GB'
e5565833
C
273# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
274# min_lifetime: '48 hours'
d9bdd007
C
275# strategy: 'trending' # Cache trending videos
276# -
277# size: '10GB'
e5565833
C
278# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
279# min_lifetime: '48 hours'
d9bdd007 280# strategy: 'recently-added' # Cache recently added videos
e5565833 281# min_views: 10 # Having at least x views
c48e82b5 282
8c9e7875
C
283# Other instances that duplicate your content
284remote_redundancy:
285 videos:
286 # 'nobody': Do not accept remote redundancies
287 # 'anybody': Accept remote redundancies from anybody
288 # 'followings': Accept redundancies from instance followings
289 accept_from: 'anybody'
290
539d3f4f
C
291csp:
292 enabled: false
293 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
294 report_uri:
295
8155db66
C
296security:
297 # Set the X-Frame-Options header to help to mitigate clickjacking attacks
298 frameguard:
299 enabled: true
300
47653481
C
301 # Set x-powered-by HTTP header to "PeerTube"
302 # Can help remote software to know this is a PeerTube instance
303 powered_by_header:
304 enabled: true
305
31b6ddf8 306tracker:
a4152bed 307 # If you disable the tracker, you disable the P2P on your PeerTube instance
31b6ddf8 308 enabled: true
de7f1114
C
309 # Only handle requests on your videos
310 # If you set this to false it means you have a public tracker
31b6ddf8
C
311 # Then, it is possible that clients overload your instance with external torrents
312 private: true
313 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
314 reject_too_many_announces: false
315
8f0bc73d
C
316history:
317 videos:
318 # If you want to limit users videos history
319 # -1 means there is no limitations
320 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
321 max_age: -1
539d3f4f 322
cda03765
C
323views:
324 videos:
325 # PeerTube creates a database entry every hour for each video to track views over a period of time
326 # This is used in particular by the Trending page
327 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
328 # -1 means no cleanup
329 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
330 remote:
acfa2e30 331 max_age: '30 days'
cda03765 332
51353d9a
C
333 # PeerTube buffers local video views before updating and federating the video
334 local_buffer_update_interval: '30 minutes'
335
336 ip_view_expiration: '1 hour'
337
b2111066
C
338# Used to get country location of views of local videos
339geo_ip:
340 enabled: true
341
342 country:
343 database_url: 'https://dbip.mirror.framasoft.org/files/dbip-country-lite-latest.mmdb'
344
6702a1b2 345plugins:
aafbc63a
C
346 # The website PeerTube will ask for available PeerTube plugins and themes
347 # This is an unmoderated plugin index, so only install plugins/themes you trust
6702a1b2
C
348 index:
349 enabled: true
df9a1a13 350 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
6702a1b2
C
351 url: 'https://packages.joinpeertube.org'
352
3092e9bb
LB
353federation:
354 videos:
87568f93 355 federate_unlisted: false
3092e9bb 356
74d249bc
C
357 # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
358 # It removes objects that do not exist anymore, and potentially fix their URLs
c5e53d0e 359 cleanup_remote_interactions: true
74d249bc 360
32a18cbf
C
361peertube:
362 check_latest_version:
363 # Check and notify admins of new PeerTube versions
364 enabled: true
365 # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
366 url: 'https://joinpeertube.org/api/v1/versions.json'
cda03765 367
8d8a037e
JB
368webadmin:
369 configuration:
cf0c8ee5 370 edition:
e89392d7
C
371 # Set this to false if you don't want to allow config edition in the web interface by instance admins
372 allowed: true
8d8a037e 373
db9d882c
C
374# XML, Atom or JSON feeds
375feeds:
376 videos:
377 # Default number of videos displayed in feeds
378 count: 20
379
380 comments:
381 # Default number of comments displayed in feeds
382 count: 20
383
0c9668f7
C
384remote_runners:
385 # Consider jobs that are processed by a remote runner as stalled after this period of time without any update
386 stalled_jobs:
387 live: '30 seconds'
388 vod: '2 minutes'
389
509cd56a
C
390###############################################################################
391#
db9d882c 392# From this point, almost all following keys can be overridden by the web interface
509cd56a
C
393# (local-production.json file). If you need to change some values, prefer to
394# use the web interface because the configuration will be automatically
de7f1114 395# reloaded without any need to restart PeerTube
509cd56a 396#
db9d882c
C
397# /!\ If you already have a local-production.json file, modification of some of
398# the following keys will have no effect /!\
509cd56a
C
399#
400###############################################################################
401
62ccb24e
C
402cache:
403 previews:
f842e810
C
404 size: 500 # Max number of previews you want to cache
405 captions:
406 size: 500 # Max number of video captions/subtitles you want to cache
90a8bd30
C
407 torrents:
408 size: 500 # Max number of video torrents you want to cache
62ccb24e 409
4793c343 410admin:
a4101923
C
411 # Used to generate the root user at first startup
412 # And to receive emails from the contact form
4793c343 413 email: 'admin@example.com'
e22528ac 414
a4101923
C
415contact_form:
416 enabled: true
417
e22528ac
C
418signup:
419 enabled: false
e364e31e 420
62ccb24e 421 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
e364e31e 422
e89392d7 423 minimum_age: 16 # Used to configure the signup form
e364e31e
C
424
425 # Users fill a form to register so moderators can accept/reject the registration
426 requires_approval: true
d9eaee39 427 requires_email_verification: false
e364e31e 428
6401417d 429 filters:
ff2c1fe8
RK
430 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
431 whitelist: []
432 blacklist: []
227d02fe 433
7b59f76e 434user:
b302c80d
W
435 history:
436 videos:
437 # Enable or disable video history by default for new users.
438 enabled: true
de7f1114
C
439 # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
440 # Byte format is supported ("1GB" etc)
b0f9f39e
C
441 # -1 == unlimited
442 video_quota: -1
bee0abff 443 video_quota_daily: -1
b0f9f39e 444
754b6f5f
FC
445video_channels:
446 max_per_user: 20 # Allows each user to create up to 20 video channels.
447
97b6428a 448# If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
de7f1114 449# In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions
09f35e2a 450# Please, do not disable transcoding since many uploaded videos will not work
227d02fe 451transcoding:
1125c40a 452 enabled: true
1896bca0 453
fccbbc1a 454 # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
14e2014a 455 allow_additional_extensions: true
1896bca0 456
536598cf
C
457 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
458 allow_audio_files: true
1896bca0 459
0c9668f7
C
460 # Enable remote runners to transcode your videos
461 # If enabled, your instance won't transcode the videos itself
462 # At least 1 remote runner must be configured to transcode your videos
463 remote_runners:
464 enabled: false
465
466 # Amount of threads used by ffmpeg for 1 local transcoding job
98f535a5 467 threads: 1
0c9668f7 468 # Amount of local transcoding jobs to execute in parallel
9129b769 469 concurrency: 1
1896bca0 470
0c9668f7 471 # Choose the local transcoding profile
1896bca0
C
472 # New profiles can be added by plugins
473 # Available in core PeerTube: 'default'
474 profile: 'default'
475
09f35e2a 476 resolutions: # Only created if the original video has a higher resolution, uses more storage!
6ad88df8 477 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
8dd754c7 478 144p: false
1125c40a
C
479 240p: false
480 360p: false
481 480p: false
482 720p: false
483 1080p: false
b7085c71 484 1440p: false
ad3405d0 485 2160p: false
d7a25329 486
84cae54e
C
487 # Transcode and keep original resolution, even if it's above your maximum enabled resolution
488 always_transcode_original_resolution: true
489
d7a25329
C
490 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
491 # If you also enabled the hls format, it will multiply videos storage by 2
04cda1d7 492 # If disabled, breaks federation with PeerTube instances < 2.1
d7a25329 493 webtorrent:
6a882428 494 enabled: false
d7a25329 495
5d9e4eaa 496 # /!\ Requires ffmpeg >= 4.1
7f8f8bdb 497 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
09209296
C
498 # * Resolution change is smoother
499 # * Faster playback in particular with long videos
500 # * More stable playback (less bugs/infinite loading)
d7a25329 501 # If you also enabled the webtorrent format, it will multiply videos storage by 2
09209296 502 hls:
6a882428 503 enabled: true
66b16caf 504
d2345ce9
C
505live:
506 enabled: false
507
508 # Limit lives duration
1896bca0 509 # -1 == unlimited
c9bc850e 510 max_duration: -1 # For example: '5 hours'
d2345ce9
C
511
512 # Limit max number of live videos created on your instance
513 # -1 == unlimited
514 max_instance_lives: 20
515
516 # Limit max number of live videos created by a user on your instance
517 # -1 == unlimited
518 max_user_lives: 3
519
520 # Allow your users to save a replay of their live
521 # PeerTube will transcode segments in a video file
522 # If the user daily/total quota is reached, PeerTube will stop the live
523 # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
524 allow_replay: true
525
f443a746
C
526 # Allow your users to change latency settings (small latency/default/high latency)
527 # Small latency live streams cannot use P2P
528 # High latency live streams can increase P2P ratio
529 latency_setting:
530 enabled: true
531
4f20856e 532 # Your firewall should accept traffic from this port in TCP if you enable live
d2345ce9 533 rtmp:
df1db951 534 enabled: true
cfbe6be5 535
9c5e5822 536 # Listening hostname/port for RTMP server
d322f854
C
537 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
538 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
539 hostname: null
cfbe6be5
C
540 port: 1935
541
9c5e5822 542 # Public hostname of your RTMP server
cfbe6be5
C
543 # Use null to use the same value than `webserver.hostname`
544 public_hostname: null
d2345ce9 545
df1db951
C
546 rtmps:
547 enabled: false
cfbe6be5 548
9c5e5822 549 # Listening hostname/port for RTMPS server
d322f854
C
550 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
551 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
552 hostname: null
df1db951 553 port: 1936
cfbe6be5
C
554
555 # Absolute paths
df1db951
C
556 key_file: ''
557 cert_file: ''
cfbe6be5 558
9c5e5822 559 # Public hostname of your RTMPS server
cfbe6be5
C
560 # Use null to use the same value than `webserver.hostname`
561 public_hostname: null
df1db951 562
d2345ce9
C
563 # Allow to transcode the live streaming in multiple live resolutions
564 transcoding:
cf3e0d69 565 enabled: true
0c9668f7
C
566
567 # Enable remote runners to transcode your videos
568 # If enabled, your instance won't transcode the videos itself
569 # At least 1 remote runner must be configured to transcode your videos
570 remote_runners:
571 enabled: false
572
573 # Amount of threads used by ffmpeg per live when using local transcoding
d2345ce9
C
574 threads: 2
575
0c9668f7 576 # Choose the local transcoding profile
1896bca0
C
577 # New profiles can be added by plugins
578 # Available in core PeerTube: 'default'
579 profile: 'default'
580
d2345ce9 581 resolutions:
8dd754c7 582 144p: false
d2345ce9
C
583 240p: false
584 360p: false
585 480p: false
586 720p: false
587 1080p: false
b7085c71 588 1440p: false
d2345ce9
C
589 2160p: false
590
84cae54e
C
591 # Also transcode original resolution, even if it's above your maximum enabled resolution
592 always_transcode_original_resolution: true
593
92e66e04 594video_studio:
c729caf6 595 # Enable video edition by users (cut, add intro/outro, add watermark etc)
a5a1690d 596 # If enabled, users can create transcoding tasks as they wish
c729caf6
C
597 enabled: false
598
5e47f6ab
C
599
600 # Enable remote runners to transcode studio tasks
601 # If enabled, your instance won't transcode the videos itself
602 # At least 1 remote runner must be configured to transcode your videos
603 remote_runners:
604 enabled: false
605
5d08a6a7
C
606import:
607 # Add ability for your users to import remote videos (from YouTube, torrent...)
608 videos:
9129b769
C
609 # Amount of import jobs to execute in parallel
610 concurrency: 1
611
3eba7ab8
C
612 # Set a custom video import timeout to not block import queue
613 timeout: '2 hours'
614
474542d7
C
615 # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
616 http:
617 # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server
f44cd95c 618 # See https://docs.joinpeertube.org/maintain/configuration#security for more information
5d08a6a7 619 enabled: false
e0409585 620
de7f1114
C
621 youtube_dl_release:
622 # Direct download URL to youtube-dl binary
623 # Github releases API is also supported
624 # Examples:
625 # * https://api.github.com/repos/ytdl-org/youtube-dl/releases
626 # * https://api.github.com/repos/yt-dlp/yt-dlp/releases
f7569270
C
627 # * https://yt-dl.org/downloads/latest/youtube-dl
628 url: 'https://api.github.com/repos/yt-dlp/yt-dlp/releases'
de7f1114 629
f7569270
C
630 # Release binary name: 'yt-dlp' or 'youtube-dl'
631 name: 'yt-dlp'
de7f1114 632
22c77786
F
633 # Path to the python binary to execute for youtube-dl or yt-dlp
634 python_path: '/usr/bin/python3'
635
677012b4 636 # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
e0409585
C
637 force_ipv4: false
638
474542d7
C
639 # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
640 torrent:
641 # We recommend to only enable magnet URI/torrent import if you trust your users
f44cd95c 642 # See https://docs.joinpeertube.org/maintain/configuration#security for more information
a84b8fa5 643 enabled: false
5d08a6a7 644
0c9668f7 645 # Add ability for your users to synchronize their channels with external channels, playlists, etc
2a491182
F
646 video_channel_synchronization:
647 enabled: false
648
649 max_per_user: 10
650
651 check_interval: 1 hour
652
653 # Number of latest published videos to check and to potentially import when syncing a channel
654 videos_limit_per_synchronization: 10
655
4efa5535
C
656 # Max number of videos to import when the user asks for full sync
657 full_sync_videos_limit: 1000
658
7ccddd7b
JM
659auto_blacklist:
660 # New videos automatically blacklisted so moderators can review before publishing
661 videos:
662 of_users:
5b9c965d
C
663 enabled: false
664
95540ed2 665# Instance settings
66b16caf
C
666instance:
667 name: 'PeerTube'
51de2c7f 668 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
8ae03c37
C
669 description: 'Welcome to this PeerTube instance!' # Support markdown
670 terms: 'No terms for now.' # Support markdown
671 code_of_conduct: '' # Supports markdown
672
673 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
674 moderation_information: '' # Supports markdown
675
676 # Why did you create this instance?
d605328a 677 creation_reason: '' # Supports Markdown
8ae03c37
C
678
679 # Who is behind the instance? A single person? A non profit?
d605328a 680 administrator: '' # Supports Markdown
8ae03c37
C
681
682 # How long do you plan to maintain this instance?
d605328a 683 maintenance_lifetime: '' # Supports Markdown
8ae03c37 684
96a4a7c3 685 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
d605328a 686 business_model: '' # Supports Markdown
8ae03c37 687
be04c6fd 688 # If you want to explain on what type of hardware your PeerTube instance runs
97b6428a 689 # Example: '2 vCore, 2GB RAM...'
be04c6fd
C
690 hardware_information: '' # Supports Markdown
691
8ae03c37
C
692 # What are the main languages of your instance? To interact with your users for example
693 # Uncomment or add the languages you want
694 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
695 languages:
696# - en
697# - es
698# - fr
699
700 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
701 # Uncomment or add the category ids you want
702 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
703 categories:
704# - 1 # Music
705# - 2 # Films
706# - 3 # Vehicles
707# - 4 # Art
708# - 5 # Sports
709# - 6 # Travels
710# - 7 # Gaming
711# - 8 # People
712# - 9 # Comedy
713# - 10 # Entertainment
714# - 11 # News & Politics
715# - 12 # How To
716# - 13 # Education
717# - 14 # Activism
718# - 15 # Science & Technology
719# - 16 # Animals
720# - 17 # Kids
721# - 18 # Food
722
901637bb 723 default_client_route: '/videos/trending'
8ae03c37 724
f8802489
C
725 # Whether or not the instance is dedicated to NSFW content
726 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
727 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
728 is_nsfw: false
97b6428a 729 # By default, `do_not_list` or `blur` or `display` NSFW videos
0883b324
C
730 # Could be overridden per user with a setting
731 default_nsfw_policy: 'do_not_list'
8ae03c37 732
00b5556c
C
733 customizations:
734 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
735 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
97b6428a 736 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
ac235c37
RK
737 robots: |
738 User-agent: *
df182b37 739 Disallow:
b569b2c6
C
740 # /.well-known/security.txt rules. This endpoint is cached, so you may have to wait a few hours before viewing your changes
741 # To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
5447516b 742 securitytxt:
97b6428a 743 '# 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:'
8be1afa1
C
744
745services:
746 # Cards configuration to format video in Twitter
747 twitter:
351d5225 748 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
8be1afa1
C
749 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
750 # If false, we use an image link card that will redirect on your PeerTube instance
97b6428a 751 # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
19f7b248 752 whitelisted: false
5b9c965d
C
753
754followers:
755 instance:
756 # Allow or not other instances to follow yours
757 enabled: true
14893eb7
C
758 # Whether or not an administrator must manually validate a new follower
759 manual_approval: false
7cd4d2ba 760
8424c402
C
761followings:
762 instance:
763 # If you want to automatically follow back new instance followers
764 # If this option is enabled, use the mute feature instead of deleting followings
765 # /!\ Don't enable this if you don't have a reactive moderation team /!\
766 auto_follow_back:
767 enabled: false
768
769 # If you want to automatically follow instances of the public index
770 # If this option is enabled, use the mute feature instead of deleting followings
771 # /!\ Don't enable this if you don't have a reactive moderation team /!\
772 auto_follow_index:
773 enabled: false
95cd31f1
C
774 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
775 index_url: ''
8424c402 776
7cd4d2ba
C
777theme:
778 default: 'default'
72c33e71
C
779
780broadcast_message:
781 enabled: false
782 message: '' # Support markdown
783 level: 'info' # 'info' | 'warning' | 'error'
784 dismissable: false
5fb2e288
C
785
786search:
787 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
788 # If enabled, the associated group will be able to "escape" from the instance follows
789 # That means they will be able to follow channels, watch videos, list videos of non followed instances
790 remote_uri:
791 users: true
792 anonymous: false
793
794 # Use a third party index instead of your local index, only for search results
795 # Useful to discover content outside of your instance
796 # If you enable search_index, you must enable remote_uri search for users
797 # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
798 # instead of loading the video locally
799 search_index:
800 enabled: false
801 # URL of the search index, that should use the same search API and routes
b5f38b78 802 # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
5fb2e288
C
803 # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
804 # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
805 url: ''
0c9668f7 806 # You can disable local search in the client, so users only use the search index
5fb2e288 807 disable_local_search: false
0c9668f7 808 # If you did not disable local search in the client, you can decide to use the search index by default
5fb2e288 809 is_default_search: false
3cf68b86
C
810
811# PeerTube client/interface configuration
812client:
813 videos:
814 miniature:
815 # By default PeerTube client displays author username
816 prefer_author_display_name: false
2c102aac 817 display_author_avatar: false
60233e90 818 resumable_upload:
819 # Max size of upload chunks, e.g. '90MB'
820 # If null, it will be calculated based on network speed
821 max_chunk_size: null
3cf68b86
C
822
823 menu:
824 login:
825 # If you enable only one external auth plugin
826 # You can automatically redirect your users on this external platform when they click on the login button
827 redirect_on_single_external_auth: false