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