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