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