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