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