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