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