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