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