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