]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blob - config/default.yaml
Merge branch 'release/4.2.0' into develop
[github/Chocobozzz/PeerTube.git] / config / default.yaml
1 # /!\ YOU SHOULD NOT UPDATE THIS FILE, USE production.yaml instead /!\ #
2
3 listen:
4 hostname: '127.0.0.1'
5 port: 9000
6
7 # Correspond to your reverse proxy server_name/listen configuration (i.e., your public PeerTube instance URL)
8 webserver:
9 https: false
10 hostname: 'localhost'
11 port: 9000
12
13 rates_limit:
14 api:
15 # 50 attempts in 10 seconds
16 window: 10 seconds
17 max: 50
18 login:
19 # 15 attempts in 5 min
20 window: 5 minutes
21 max: 15
22 signup:
23 # 2 attempts in 5 min (only succeeded attempts are taken into account)
24 window: 5 minutes
25 max: 2
26 ask_send_email:
27 # 3 attempts in 5 min
28 window: 5 minutes
29 max: 3
30
31 # Proxies to trust to get real client IP
32 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
33 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
34 trust_proxy:
35 - 'loopback'
36
37 # Your database name will be database.name OR 'peertube'+database.suffix
38 database:
39 hostname: 'localhost'
40 port: 5432
41 ssl: false
42 suffix: '_dev'
43 username: 'peertube'
44 password: 'peertube'
45 pool:
46 max: 5
47
48 # Redis server for short time storage
49 # You can also specify a 'socket' path to a unix socket but first need to
50 # set 'hostname' and 'port' to null
51 redis:
52 hostname: 'localhost'
53 port: 6379
54 auth: null
55 db: 0
56
57 # SMTP server to send emails
58 smtp:
59 # smtp or sendmail
60 transport: smtp
61 # Path to sendmail command. Required if you use sendmail transport
62 sendmail: null
63 hostname: null
64 port: 465 # If you use StartTLS: 587
65 username: null
66 password: null
67 tls: true # If you use StartTLS: false
68 disable_starttls: false
69 ca_file: null # Used for self signed certificates
70 from_address: 'admin@example.com'
71
72 email:
73 body:
74 signature: 'PeerTube'
75 subject:
76 prefix: '[PeerTube]'
77
78 # Update default PeerTube values
79 # Set by API when the field is not provided and put as default value in client
80 defaults:
81 # Change default values when publishing a video (upload/import/go Live)
82 publish:
83 download_enabled: true
84
85 comments_enabled: true
86
87 # public = 1, unlisted = 2, private = 3, internal = 4
88 privacy: 1
89
90 # CC-BY = 1, CC-SA = 2, CC-ND = 3, CC-NC = 4, CC-NC-SA = 5, CC-NC-ND = 6, Public Domain = 7
91 # You can also choose a custom licence value added by a plugin
92 # No licence by default
93 licence: null
94
95 p2p:
96 # Enable P2P by default in PeerTube client
97 # Can be enabled/disabled by anonymous users and logged in users
98 webapp:
99 enabled: true
100
101 # Enable P2P by default in PeerTube embed
102 # Can be enabled/disabled by URL option
103 embed:
104 enabled: true
105
106 # From the project root directory
107 storage:
108 tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
109 bin: 'storage/bin/'
110 avatars: 'storage/avatars/'
111 videos: 'storage/videos/'
112 streaming_playlists: 'storage/streaming-playlists/'
113 redundancy: 'storage/redundancy/'
114 logs: 'storage/logs/'
115 previews: 'storage/previews/'
116 thumbnails: 'storage/thumbnails/'
117 torrents: 'storage/torrents/'
118 captions: 'storage/captions/'
119 cache: 'storage/cache/'
120 plugins: 'storage/plugins/'
121 # Overridable client files in client/dist/assets/images:
122 # - logo.svg
123 # - favicon.png
124 # - default-playlist.jpg
125 # - default-avatar-account.png
126 # - default-avatar-video-channel.png
127 # - and icons/*.png (PWA)
128 # Could contain for example assets/images/favicon.png
129 # If the file exists, peertube will serve it
130 # If not, peertube will fallback to the default file
131 client_overrides: 'storage/client-overrides/'
132
133 object_storage:
134 enabled: false
135
136 # Without protocol, will default to HTTPS
137 endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
138
139 region: 'us-east-1'
140
141 # Set this ACL on each uploaded object
142 upload_acl: 'public-read'
143
144 credentials:
145 # You can also use AWS_ACCESS_KEY_ID env variable
146 access_key_id: ''
147 # You can also use AWS_SECRET_ACCESS_KEY env variable
148 secret_access_key: ''
149
150 # Maximum amount to upload in one request to object storage
151 max_upload_part: 2GB
152
153 streaming_playlists:
154 bucket_name: 'streaming-playlists'
155
156 # Allows setting all buckets to the same value but with a different prefix
157 prefix: '' # Example: 'streaming-playlists:'
158
159 # Base url for object URL generation, scheme and host will be replaced by this URL
160 # Useful when you want to use a CDN/external proxy
161 base_url: '' # Example: 'https://mirror.example.com'
162
163 # Same settings but for webtorrent videos
164 videos:
165 bucket_name: 'videos'
166 prefix: ''
167 base_url: ''
168
169 log:
170 level: 'info' # 'debug' | 'info' | 'warn' | 'error'
171 rotation:
172 enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
173 max_file_size: 12MB
174 max_files: 20
175 anonymize_ip: false
176 log_ping_requests: true
177 prettify_sql: false
178
179 trending:
180 videos:
181 interval_days: 7 # Compute trending videos for the last x days
182 algorithms:
183 enabled:
184 - 'hot' # adaptation of Reddit's 'Hot' algorithm
185 - 'most-viewed' # default, used initially by PeerTube as the trending page
186 - 'most-liked'
187 default: 'most-viewed'
188
189 # Cache remote videos on your server, to help other instances to broadcast the video
190 # You can define multiple caches using different sizes/strategies
191 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
192 redundancy:
193 videos:
194 check_interval: '1 hour' # How often you want to check new videos to cache
195 strategies: # Just uncomment strategies you want
196 # -
197 # size: '10GB'
198 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
199 # min_lifetime: '48 hours'
200 # strategy: 'most-views' # Cache videos that have the most views
201 # -
202 # size: '10GB'
203 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
204 # min_lifetime: '48 hours'
205 # strategy: 'trending' # Cache trending videos
206 # -
207 # size: '10GB'
208 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
209 # min_lifetime: '48 hours'
210 # strategy: 'recently-added' # Cache recently added videos
211 # min_views: 10 # Having at least x views
212
213 # Other instances that duplicate your content
214 remote_redundancy:
215 videos:
216 # 'nobody': Do not accept remote redundancies
217 # 'anybody': Accept remote redundancies from anybody
218 # 'followings': Accept redundancies from instance followings
219 accept_from: 'anybody'
220
221 csp:
222 enabled: false
223 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
224 report_uri:
225
226 security:
227 # Set the X-Frame-Options header to help to mitigate clickjacking attacks
228 frameguard:
229 enabled: true
230
231 tracker:
232 # If you disable the tracker, you disable the P2P on your PeerTube instance
233 enabled: true
234 # Only handle requests on your videos
235 # If you set this to false it means you have a public tracker
236 # Then, it is possible that clients overload your instance with external torrents
237 private: true
238 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
239 reject_too_many_announces: false
240
241 history:
242 videos:
243 # If you want to limit users videos history
244 # -1 means there is no limitations
245 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
246 max_age: -1
247
248 views:
249 videos:
250 # PeerTube creates a database entry every hour for each video to track views over a period of time
251 # This is used in particular by the Trending page
252 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
253 # -1 means no cleanup
254 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
255 remote:
256 max_age: '30 days'
257
258 # PeerTube buffers local video views before updating and federating the video
259 local_buffer_update_interval: '30 minutes'
260
261 ip_view_expiration: '1 hour'
262
263 # Used to get country location of views of local videos
264 geo_ip:
265 enabled: true
266
267 country:
268 database_url: 'https://dbip.mirror.framasoft.org/files/dbip-country-lite-latest.mmdb'
269
270 plugins:
271 # The website PeerTube will ask for available PeerTube plugins and themes
272 # This is an unmoderated plugin index, so only install plugins/themes you trust
273 index:
274 enabled: true
275 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
276 url: 'https://packages.joinpeertube.org'
277
278 federation:
279 videos:
280 federate_unlisted: false
281
282 # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
283 # It removes objects that do not exist anymore, and potentially fix their URLs
284 cleanup_remote_interactions: true
285
286 peertube:
287 check_latest_version:
288 # Check and notify admins of new PeerTube versions
289 enabled: true
290 # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
291 url: 'https://joinpeertube.org/api/v1/versions.json'
292
293 webadmin:
294 configuration:
295 edition:
296 # Set this to false if you don't want to allow config edition in the web interface by instance admins
297 allowed: true
298
299 # XML, Atom or JSON feeds
300 feeds:
301 videos:
302 # Default number of videos displayed in feeds
303 count: 20
304
305 comments:
306 # Default number of comments displayed in feeds
307 count: 20
308
309 cache:
310 previews:
311 size: 500 # Max number of previews you want to cache
312 captions:
313 size: 500 # Max number of video captions/subtitles you want to cache
314 torrents:
315 size: 500 # Max number of video torrents you want to cache
316
317 admin:
318 # Used to generate the root user at first startup
319 # And to receive emails from the contact form
320 email: 'admin@example.com'
321
322 contact_form:
323 enabled: true
324
325 signup:
326 enabled: false
327 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
328 minimum_age: 16 # Used to configure the signup form
329 requires_email_verification: false
330 filters:
331 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
332 whitelist: []
333 blacklist: []
334
335 user:
336 # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
337 # Byte format is supported ("1GB" etc)
338 # -1 == unlimited
339 video_quota: -1
340 video_quota_daily: -1
341
342 video_channels:
343 max_per_user: 20 # Allows each user to create up to 20 video channels.
344
345 # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
346 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions
347 # Please, do not disable transcoding since many uploaded videos will not work
348 transcoding:
349 enabled: true
350
351 # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
352 allow_additional_extensions: true
353
354 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
355 allow_audio_files: true
356
357 # Amount of threads used by ffmpeg for 1 transcoding job
358 threads: 1
359 # Amount of transcoding jobs to execute in parallel
360 concurrency: 1
361
362 # Choose the transcoding profile
363 # New profiles can be added by plugins
364 # Available in core PeerTube: 'default'
365 profile: 'default'
366
367 resolutions: # Only created if the original video has a higher resolution, uses more storage!
368 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
369 144p: false
370 240p: false
371 360p: false
372 480p: false
373 720p: false
374 1080p: false
375 1440p: false
376 2160p: false
377
378 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
379 # If you also enabled the hls format, it will multiply videos storage by 2
380 # If disabled, breaks federation with PeerTube instances < 2.1
381 webtorrent:
382 enabled: false
383
384 # /!\ Requires ffmpeg >= 4.1
385 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
386 # * Resolution change is smoother
387 # * Faster playback in particular with long videos
388 # * More stable playback (less bugs/infinite loading)
389 # If you also enabled the webtorrent format, it will multiply videos storage by 2
390 hls:
391 enabled: true
392
393 live:
394 enabled: false
395
396 # Limit lives duration
397 # -1 == unlimited
398 max_duration: -1 # For example: '5 hours'
399
400 # Limit max number of live videos created on your instance
401 # -1 == unlimited
402 max_instance_lives: 20
403
404 # Limit max number of live videos created by a user on your instance
405 # -1 == unlimited
406 max_user_lives: 3
407
408 # Allow your users to save a replay of their live
409 # PeerTube will transcode segments in a video file
410 # If the user daily/total quota is reached, PeerTube will stop the live
411 # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
412 allow_replay: true
413
414 # Allow your users to change latency settings (small latency/default/high latency)
415 # Small latency live streams cannot use P2P
416 # High latency live streams can increase P2P ratio
417 latency_setting:
418 enabled: true
419
420 # Your firewall should accept traffic from this port in TCP if you enable live
421 rtmp:
422 enabled: true
423
424 # Listening hostname/port for RTMP server
425 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
426 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
427 hostname: null
428 port: 1935
429
430 # Public hostname of your RTMP server
431 # Use null to use the same value than `webserver.hostname`
432 public_hostname: null
433
434 rtmps:
435 enabled: false
436
437 # Listening hostname/port for RTMPS server
438 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
439 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
440 hostname: null
441 port: 1936
442
443 # Absolute paths
444 key_file: ''
445 cert_file: ''
446
447 # Public hostname of your RTMPS server
448 # Use null to use the same value than `webserver.hostname`
449 public_hostname: null
450
451 # Allow to transcode the live streaming in multiple live resolutions
452 transcoding:
453 enabled: true
454 threads: 2
455
456 # Choose the transcoding profile
457 # New profiles can be added by plugins
458 # Available in core PeerTube: 'default'
459 profile: 'default'
460
461 resolutions:
462 144p: false
463 240p: false
464 360p: false
465 480p: false
466 720p: false
467 1080p: false
468 1440p: false
469 2160p: false
470
471 video_studio:
472 # Enable video edition by users (cut, add intro/outro, add watermark etc)
473 # If enabled, users can create transcoding tasks as they wish
474 enabled: false
475
476 import:
477 # Add ability for your users to import remote videos (from YouTube, torrent...)
478 videos:
479 # Amount of import jobs to execute in parallel
480 concurrency: 1
481
482 # Set a custom video import timeout to not block import queue
483 timeout: '2 hours'
484
485 # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
486 http:
487 # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server
488 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
489 enabled: false
490
491 youtube_dl_release:
492 # Direct download URL to youtube-dl binary
493 # Github releases API is also supported
494 # Examples:
495 # * https://api.github.com/repos/ytdl-org/youtube-dl/releases
496 # * https://api.github.com/repos/yt-dlp/yt-dlp/releases
497 url: 'https://yt-dl.org/downloads/latest/youtube-dl'
498
499 # youtube-dl binary name
500 # yt-dlp is also supported
501 name: 'youtube-dl'
502
503 # Path to the python binary to execute for youtube-dl or yt-dlp
504 python_path: '/usr/bin/python3'
505
506 # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
507 force_ipv4: false
508
509 # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
510 torrent:
511 # We recommend to only enable magnet URI/torrent import if you trust your users
512 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
513 enabled: false
514
515 auto_blacklist:
516 # New videos automatically blacklisted so moderators can review before publishing
517 videos:
518 of_users:
519 enabled: false
520
521 # Instance settings
522 instance:
523 name: 'PeerTube'
524 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
525 description: 'Welcome to this PeerTube instance!' # Support markdown
526 terms: 'No terms for now.' # Support markdown
527 code_of_conduct: '' # Supports markdown
528
529 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
530 moderation_information: '' # Supports markdown
531
532 # Why did you create this instance?
533 creation_reason: '' # Supports Markdown
534
535 # Who is behind the instance? A single person? A non profit?
536 administrator: '' # Supports Markdown
537
538 # How long do you plan to maintain this instance?
539 maintenance_lifetime: '' # Supports Markdown
540
541 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
542 business_model: '' # Supports Markdown
543
544 # If you want to explain on what type of hardware your PeerTube instance runs
545 # Example: '2 vCore, 2GB RAM...'
546 hardware_information: '' # Supports Markdown
547
548 # What are the main languages of your instance? To interact with your users for example
549 # Uncomment or add the languages you want
550 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
551 languages:
552 # - en
553 # - es
554 # - fr
555
556 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
557 # Uncomment or add the category ids you want
558 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
559 categories:
560 # - 1 # Music
561 # - 2 # Films
562 # - 3 # Vehicles
563 # - 4 # Art
564 # - 5 # Sports
565 # - 6 # Travels
566 # - 7 # Gaming
567 # - 8 # People
568 # - 9 # Comedy
569 # - 10 # Entertainment
570 # - 11 # News & Politics
571 # - 12 # How To
572 # - 13 # Education
573 # - 14 # Activism
574 # - 15 # Science & Technology
575 # - 16 # Animals
576 # - 17 # Kids
577 # - 18 # Food
578
579 default_client_route: '/videos/trending'
580
581 # Whether or not the instance is dedicated to NSFW content
582 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
583 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
584 is_nsfw: false
585 # By default, `do_not_list` or `blur` or `display` NSFW videos
586 # Could be overridden per user with a setting
587 default_nsfw_policy: 'do_not_list'
588
589 customizations:
590 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
591 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
592 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
593 robots: |
594 User-agent: *
595 Disallow:
596 # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
597 securitytxt:
598 '# 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:'
599
600 services:
601 # Cards configuration to format video in Twitter
602 twitter:
603 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
604 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
605 # If false, we use an image link card that will redirect on your PeerTube instance
606 # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
607 whitelisted: false
608
609 followers:
610 instance:
611 # Allow or not other instances to follow yours
612 enabled: true
613 # Whether or not an administrator must manually validate a new follower
614 manual_approval: false
615
616 followings:
617 instance:
618 # If you want to automatically follow back new instance followers
619 # If this option is enabled, use the mute feature instead of deleting followings
620 # /!\ Don't enable this if you don't have a reactive moderation team /!\
621 auto_follow_back:
622 enabled: false
623
624 # If you want to automatically follow instances of the public index
625 # If this option is enabled, use the mute feature instead of deleting followings
626 # /!\ Don't enable this if you don't have a reactive moderation team /!\
627 auto_follow_index:
628 enabled: false
629 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
630 index_url: ''
631
632 theme:
633 default: 'default'
634
635 broadcast_message:
636 enabled: false
637 message: '' # Support markdown
638 level: 'info' # 'info' | 'warning' | 'error'
639 dismissable: false
640
641 search:
642 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
643 # If enabled, the associated group will be able to "escape" from the instance follows
644 # That means they will be able to follow channels, watch videos, list videos of non followed instances
645 remote_uri:
646 users: true
647 anonymous: false
648
649 # Use a third party index instead of your local index, only for search results
650 # Useful to discover content outside of your instance
651 # If you enable search_index, you must enable remote_uri search for users
652 # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
653 # instead of loading the video locally
654 search_index:
655 enabled: false
656 # URL of the search index, that should use the same search API and routes
657 # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
658 # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
659 # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
660 url: ''
661 # You can disable local search, so users only use the search index
662 disable_local_search: false
663 # If you did not disable local search, you can decide to use the search index by default
664 is_default_search: false
665
666 # PeerTube client/interface configuration
667 client:
668 videos:
669 miniature:
670 # By default PeerTube client displays author username
671 prefer_author_display_name: false
672 display_author_avatar: false
673 resumable_upload:
674 # Max size of upload chunks, e.g. '90MB'
675 # If null, it will be calculated based on network speed
676 max_chunk_size: null
677
678 menu:
679 login:
680 # If you enable only one external auth plugin
681 # You can automatically redirect your users on this external platform when they click on the login button
682 redirect_on_single_external_auth: false