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