]>
Commit | Line | Data |
---|---|---|
6401417d C |
1 | # /!\ YOU SHOULD NOT UPDATE THIS FILE, USE production.yaml instead /!\ # |
2 | ||
8c308c2b | 3 | listen: |
cff8b272 | 4 | hostname: '127.0.0.1' |
8c308c2b C |
5 | port: 9000 |
6 | ||
d8658f0f | 7 | # Correspond to your reverse proxy server_name/listen configuration (i.e., your public PeerTube instance URL) |
8c308c2b C |
8 | webserver: |
9 | https: false | |
3737bbaf | 10 | hostname: 'localhost' |
8c308c2b C |
11 | port: 9000 |
12 | ||
c342726a | 13 | rates_limit: |
c1340a6a C |
14 | api: |
15 | # 50 attempts in 10 seconds | |
16 | window: 10 seconds | |
0502e3d0 | 17 | max: 100 |
c342726a YB |
18 | login: |
19 | # 15 attempts in 5 min | |
20 | window: 5 minutes | |
21 | max: 15 | |
c1340a6a C |
22 | signup: |
23 | # 2 attempts in 5 min (only succeeded attempts are taken into account) | |
24 | window: 5 minutes | |
25 | max: 2 | |
c342726a YB |
26 | ask_send_email: |
27 | # 3 attempts in 5 min | |
28 | window: 5 minutes | |
29 | max: 3 | |
30 | ||
490b595a C |
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 | ||
6ee72211 | 37 | # Your database name will be database.name OR "peertube"+database.suffix |
8c308c2b | 38 | database: |
3737bbaf | 39 | hostname: 'localhost' |
feb4bdfd | 40 | port: 5432 |
b0ce7c39 | 41 | ssl: false |
feb4bdfd | 42 | suffix: '_dev' |
55fa55a9 C |
43 | username: 'peertube' |
44 | password: 'peertube' | |
1c3386e8 RK |
45 | pool: |
46 | max: 5 | |
8c308c2b | 47 | |
19f7b248 RK |
48 | # You can also specify a 'socket' path to a unix socket but first need to |
49 | # comment out hostname and port | |
94a5ff8a C |
50 | redis: |
51 | hostname: 'localhost' | |
52 | port: 6379 | |
53 | auth: null | |
30c82f0d | 54 | db: 0 |
94a5ff8a | 55 | |
ecb4e35f | 56 | smtp: |
ed3f089c IB |
57 | # smtp or sendmail |
58 | transport: smtp | |
59 | # Path to sendmail command. Required if you use sendmail transport | |
60 | sendmail: null | |
ecb4e35f C |
61 | hostname: null |
62 | port: 465 | |
63 | username: null | |
64 | password: null | |
65 | tls: true | |
bebf2d89 | 66 | disable_starttls: false |
ecb4e35f C |
67 | ca_file: null # Used for self signed certificates |
68 | from_address: 'admin@example.com' | |
69 | ||
b5bfadf0 YB |
70 | email: |
71 | body: | |
72 | signature: "PeerTube" | |
916937d7 | 73 | subject: |
b5bfadf0 YB |
74 | prefix: "[PeerTube]" |
75 | ||
8c308c2b C |
76 | # From the project root directory |
77 | storage: | |
aafbc63a | 78 | tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before processing... |
6b2ef589 | 79 | avatars: 'storage/avatars/' |
6b2ef589 | 80 | videos: 'storage/videos/' |
9c6ca37f | 81 | streaming_playlists: 'storage/streaming-playlists/' |
6040f87d | 82 | redundancy: 'storage/redundancy/' |
6b2ef589 C |
83 | logs: 'storage/logs/' |
84 | previews: 'storage/previews/' | |
85 | thumbnails: 'storage/thumbnails/' | |
86 | torrents: 'storage/torrents/' | |
40e87e9e | 87 | captions: 'storage/captions/' |
6b2ef589 | 88 | cache: 'storage/cache/' |
345da516 | 89 | plugins: 'storage/plugins/' |
caf2aaf4 K |
90 | # Overridable client files : logo.svg, favicon.png and icons/*.png (PWA) in client/dist/assets/images |
91 | # Could contain for example assets/images/favicon.png | |
92 | # If the file exists, peertube will serve it | |
93 | # If not, peertube will fallback to the default fil | |
94 | client_overrides: 'storage/client-overrides/' | |
f981dae8 | 95 | |
23e27dd5 | 96 | log: |
a0922eb9 | 97 | level: 'info' # debug/info/warning/error |
fcf4569f | 98 | rotation: |
aafbc63a | 99 | enabled : true |
2f6b5e2d C |
100 | maxFileSize: 12MB |
101 | maxFiles: 20 | |
102 | anonymizeIP: false | |
12c1e38d | 103 | log_ping_requests: true |
23e27dd5 | 104 | |
9a629c6e C |
105 | trending: |
106 | videos: | |
107 | interval_days: 7 # Compute trending videos for the last x days | |
108 | ||
c48e82b5 C |
109 | # Cache remote videos on your server, to help other instances to broadcast the video |
110 | # You can define multiple caches using different sizes/strategies | |
111 | # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following | |
112 | redundancy: | |
113 | videos: | |
f9f899b9 | 114 | check_interval: '1 hour' # How often you want to check new videos to cache |
6040f87d | 115 | strategies: # Just uncomment strategies you want |
d9bdd007 C |
116 | # - |
117 | # size: '10GB' | |
e5565833 C |
118 | # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances) |
119 | # min_lifetime: '48 hours' | |
d9bdd007 C |
120 | # strategy: 'most-views' # Cache videos that have the most views |
121 | # - | |
122 | # size: '10GB' | |
e5565833 C |
123 | # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances) |
124 | # min_lifetime: '48 hours' | |
d9bdd007 C |
125 | # strategy: 'trending' # Cache trending videos |
126 | # - | |
127 | # size: '10GB' | |
e5565833 C |
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' | |
d9bdd007 | 130 | # strategy: 'recently-added' # Cache recently added videos |
e5565833 | 131 | # min_views: 10 # Having at least x views |
c48e82b5 | 132 | |
8c9e7875 C |
133 | # Other instances that duplicate your content |
134 | remote_redundancy: | |
135 | videos: | |
136 | # 'nobody': Do not accept remote redundancies | |
137 | # 'anybody': Accept remote redundancies from anybody | |
138 | # 'followings': Accept redundancies from instance followings | |
139 | accept_from: 'anybody' | |
140 | ||
539d3f4f C |
141 | csp: |
142 | enabled: false | |
143 | report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk! | |
144 | report_uri: | |
145 | ||
31b6ddf8 C |
146 | tracker: |
147 | # If you disable the tracker, you disable the P2P aspect of PeerTube | |
148 | enabled: true | |
149 | # Only handle requests on your videos. | |
150 | # If you set this to false it means you have a public tracker. | |
151 | # Then, it is possible that clients overload your instance with external torrents | |
152 | private: true | |
153 | # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers) | |
154 | reject_too_many_announces: false | |
155 | ||
8f0bc73d C |
156 | history: |
157 | videos: | |
158 | # If you want to limit users videos history | |
159 | # -1 means there is no limitations | |
160 | # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database) | |
161 | max_age: -1 | |
162 | ||
cda03765 C |
163 | views: |
164 | videos: | |
165 | # PeerTube creates a database entry every hour for each video to track views over a period of time | |
166 | # This is used in particular by the Trending page | |
167 | # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered) | |
168 | # -1 means no cleanup | |
169 | # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database) | |
170 | remote: | |
acfa2e30 | 171 | max_age: '30 days' |
cda03765 | 172 | |
6702a1b2 | 173 | plugins: |
d133f385 C |
174 | # The website PeerTube will ask for available PeerTube plugins and themes |
175 | # This is an unmoderated plugin index, so only install plugins/themes you trust | |
6702a1b2 C |
176 | index: |
177 | enabled: true | |
df9a1a13 | 178 | check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions |
6702a1b2 C |
179 | url: 'https://packages.joinpeertube.org' |
180 | ||
3092e9bb LB |
181 | federation: |
182 | videos: | |
87568f93 | 183 | federate_unlisted: false |
3092e9bb | 184 | |
f981dae8 C |
185 | cache: |
186 | previews: | |
f842e810 | 187 | size: 500 # Max number of previews you want to cache |
40e87e9e | 188 | captions: |
f842e810 | 189 | size: 500 # Max number of video captions/subtitles you want to cache |
4793c343 C |
190 | |
191 | admin: | |
a4101923 C |
192 | # Used to generate the root user at first startup |
193 | # And to receive emails from the contact form | |
194 | email: 'admin@example.com' | |
195 | ||
196 | contact_form: | |
197 | enabled: true | |
e22528ac C |
198 | |
199 | signup: | |
200 | enabled: false | |
291e8d3e | 201 | limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited |
d9eaee39 | 202 | requires_email_verification: false |
6401417d | 203 | filters: |
ff2c1fe8 RK |
204 | cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist |
205 | whitelist: [] | |
206 | blacklist: [] | |
227d02fe | 207 | |
b0f9f39e C |
208 | user: |
209 | # Default value of maximum video BYTES the user can upload (does not take into account transcoded files). | |
210 | # -1 == unlimited | |
211 | video_quota: -1 | |
bee0abff | 212 | video_quota_daily: -1 |
b0f9f39e | 213 | |
227d02fe | 214 | # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag |
40298b02 | 215 | # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions. |
09f35e2a | 216 | # Please, do not disable transcoding since many uploaded videos will not work |
227d02fe | 217 | transcoding: |
1125c40a | 218 | enabled: true |
fccbbc1a | 219 | # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos |
14e2014a | 220 | allow_additional_extensions: true |
536598cf C |
221 | # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file |
222 | allow_audio_files: true | |
98f535a5 | 223 | threads: 1 |
09f35e2a | 224 | resolutions: # Only created if the original video has a higher resolution, uses more storage! |
6ad88df8 | 225 | 0p: false # audio-only (creates mp4 without video stream, always created when enabled) |
1125c40a C |
226 | 240p: false |
227 | 360p: false | |
228 | 480p: false | |
229 | 720p: false | |
230 | 1080p: false | |
b7085c71 | 231 | 1440p: false |
ad3405d0 | 232 | 2160p: false |
d7a25329 C |
233 | |
234 | # Generate videos in a WebTorrent format (what we do since the first PeerTube release) | |
235 | # If you also enabled the hls format, it will multiply videos storage by 2 | |
04cda1d7 | 236 | # If disabled, breaks federation with PeerTube instances < 2.1 |
d7a25329 C |
237 | webtorrent: |
238 | enabled: true | |
239 | ||
5d9e4eaa | 240 | # /!\ Requires ffmpeg >= 4.1 |
7f8f8bdb | 241 | # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent: |
09209296 C |
242 | # * Resolution change is smoother |
243 | # * Faster playback in particular with long videos | |
244 | # * More stable playback (less bugs/infinite loading) | |
d7a25329 | 245 | # If you also enabled the webtorrent format, it will multiply videos storage by 2 |
09209296 C |
246 | hls: |
247 | enabled: false | |
66b16caf | 248 | |
c6c0fa6c C |
249 | live: |
250 | enabled: false | |
251 | ||
a5cf76af | 252 | # Limit lives duration |
c9bc850e C |
253 | # -1 == unlimited |
254 | max_duration: -1 # For example: '5 hours' | |
a5cf76af | 255 | |
a056ca48 C |
256 | # Limit max number of live videos created on your instance |
257 | # -1 == unlimited | |
258 | max_instance_lives: 20 | |
259 | ||
260 | # Limit max number of live videos created by a user on your instance | |
261 | # -1 == unlimited | |
262 | max_user_lives: 3 | |
263 | ||
a5cf76af C |
264 | # Allow your users to save a replay of their live |
265 | # PeerTube will transcode segments in a video file | |
266 | # If the user daily/total quota is reached, PeerTube will stop the live | |
267 | # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay | |
3cabf353 | 268 | allow_replay: false |
a5cf76af | 269 | |
4f20856e | 270 | # Your firewall should accept traffic from this port in TCP if you enable live |
c6c0fa6c C |
271 | rtmp: |
272 | port: 1935 | |
273 | ||
a5cf76af | 274 | # Allow to transcode the live streaming in multiple live resolutions |
c6c0fa6c | 275 | transcoding: |
cf3e0d69 | 276 | enabled: true |
c6c0fa6c C |
277 | threads: 2 |
278 | ||
279 | resolutions: | |
280 | 240p: false | |
281 | 360p: false | |
282 | 480p: false | |
283 | 720p: false | |
284 | 1080p: false | |
b7085c71 | 285 | 1440p: false |
c6c0fa6c C |
286 | 2160p: false |
287 | ||
fbad87b0 C |
288 | import: |
289 | # Add ability for your users to import remote videos (from YouTube, torrent...) | |
290 | videos: | |
291 | http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html | |
5d08a6a7 | 292 | enabled: false |
e0409585 | 293 | |
677012b4 | 294 | # IPv6 is very strongly rate-limited on most sites supported by youtube-dl |
e0409585 C |
295 | force_ipv4: false |
296 | ||
be7ca0c6 C |
297 | # You can use an HTTP/HTTPS/SOCKS proxy with youtube-dl |
298 | proxy: | |
299 | enabled: false | |
300 | url: "" | |
a84b8fa5 C |
301 | torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file) |
302 | enabled: false | |
fbad87b0 | 303 | |
7ccddd7b JM |
304 | auto_blacklist: |
305 | # New videos automatically blacklisted so moderators can review before publishing | |
306 | videos: | |
307 | of_users: | |
308 | enabled: false | |
309 | ||
66b16caf C |
310 | instance: |
311 | name: 'PeerTube' | |
482fa503 | 312 | short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.' |
bf874e33 C |
313 | description: 'Welcome to this PeerTube instance!' # Support markdown |
314 | terms: 'No terms for now.' # Support markdown | |
ccc00cb2 C |
315 | code_of_conduct: '' # Supports markdown |
316 | ||
317 | # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc | |
318 | moderation_information: '' # Supports markdown | |
319 | ||
8ae03c37 | 320 | # Why did you create this instance? |
d605328a | 321 | creation_reason: '' # Supports Markdown |
8ae03c37 | 322 | |
ccc00cb2 | 323 | # Who is behind the instance? A single person? A non profit? |
d605328a | 324 | administrator: '' # Supports Markdown |
ccc00cb2 C |
325 | |
326 | # How long do you plan to maintain this instance? | |
d605328a | 327 | maintenance_lifetime: '' # Supports Markdown |
ccc00cb2 | 328 | |
96a4a7c3 | 329 | # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising? |
d605328a | 330 | business_model: '' # Supports Markdown |
ccc00cb2 | 331 | |
be04c6fd C |
332 | # If you want to explain on what type of hardware your PeerTube instance runs |
333 | # Example: "2 vCore, 2GB RAM..." | |
334 | hardware_information: '' # Supports Markdown | |
335 | ||
ccc00cb2 C |
336 | # What are the main languages of your instance? To interact with your users for example |
337 | # Uncomment or add the languages you want | |
338 | # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages | |
339 | languages: | |
340 | # - en | |
341 | # - es | |
342 | # - fr | |
343 | ||
344 | # You can specify the main categories of your instance (dedicated to music, gaming or politics etc) | |
345 | # Uncomment or add the category ids you want | |
346 | # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories | |
347 | categories: | |
348 | # - 1 # Music | |
349 | # - 2 # Films | |
350 | # - 3 # Vehicles | |
351 | # - 4 # Art | |
352 | # - 5 # Sports | |
353 | # - 6 # Travels | |
354 | # - 7 # Gaming | |
355 | # - 8 # People | |
356 | # - 9 # Comedy | |
357 | # - 10 # Entertainment | |
358 | # - 11 # News & Politics | |
359 | # - 12 # How To | |
360 | # - 13 # Education | |
361 | # - 14 # Activism | |
362 | # - 15 # Science & Technology | |
363 | # - 16 # Animals | |
364 | # - 17 # Kids | |
365 | # - 18 # Food | |
366 | ||
901637bb | 367 | default_client_route: '/videos/trending' |
ccc00cb2 | 368 | |
f8802489 C |
369 | # Whether or not the instance is dedicated to NSFW content |
370 | # Enabling it will allow other administrators to know that you are mainly federating sensitive content | |
371 | # Moreover, the NSFW checkbox on video upload will be automatically checked by default | |
372 | is_nsfw: false | |
0883b324 C |
373 | # By default, "do_not_list" or "blur" or "display" NSFW videos |
374 | # Could be overridden per user with a setting | |
375 | default_nsfw_policy: 'do_not_list' | |
ccc00cb2 | 376 | |
00b5556c C |
377 | customizations: |
378 | javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime | |
379 | css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime | |
78881bc4 | 380 | # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:' |
ac235c37 RK |
381 | robots: | |
382 | User-agent: * | |
df182b37 | 383 | Disallow: |
5447516b AH |
384 | # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string. |
385 | securitytxt: | |
1f4f1510 | 386 | "# 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:" |
8be1afa1 C |
387 | |
388 | services: | |
389 | # Cards configuration to format video in Twitter | |
390 | twitter: | |
351d5225 | 391 | username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published |
8be1afa1 C |
392 | # If true, a video player will be embedded in the Twitter feed on PeerTube video share |
393 | # If false, we use an image link card that will redirect on your PeerTube instance | |
394 | # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted | |
395 | whitelisted: false | |
5b9c965d C |
396 | |
397 | followers: | |
398 | instance: | |
399 | # Allow or not other instances to follow yours | |
400 | enabled: true | |
14893eb7 C |
401 | # Whether or not an administrator must manually validate a new follower |
402 | manual_approval: false | |
7cd4d2ba | 403 | |
8424c402 C |
404 | followings: |
405 | instance: | |
406 | # If you want to automatically follow back new instance followers | |
407 | # Only follows accepted followers (in case you enabled manual followers approbation) | |
408 | # If this option is enabled, use the mute feature instead of deleting followings | |
409 | # /!\ Don't enable this if you don't have a reactive moderation team /!\ | |
410 | auto_follow_back: | |
411 | enabled: false | |
412 | ||
413 | # If you want to automatically follow instances of the public index | |
414 | # If this option is enabled, use the mute feature instead of deleting followings | |
415 | # /!\ Don't enable this if you don't have a reactive moderation team /!\ | |
416 | auto_follow_index: | |
417 | enabled: false | |
95cd31f1 C |
418 | # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow |
419 | index_url: '' | |
8424c402 | 420 | |
7cd4d2ba C |
421 | theme: |
422 | default: 'default' | |
72c33e71 C |
423 | |
424 | broadcast_message: | |
425 | enabled: false | |
426 | message: '' # Support markdown | |
427 | level: 'info' # 'info' | 'warning' | 'error' | |
428 | dismissable: false | |
5fb2e288 C |
429 | |
430 | search: | |
431 | # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance | |
432 | # If enabled, the associated group will be able to "escape" from the instance follows | |
433 | # That means they will be able to follow channels, watch videos, list videos of non followed instances | |
434 | remote_uri: | |
435 | users: true | |
436 | anonymous: false | |
437 | ||
438 | # Use a third party index instead of your local index, only for search results | |
439 | # Useful to discover content outside of your instance | |
440 | # If you enable search_index, you must enable remote_uri search for users | |
441 | # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance | |
442 | # instead of loading the video locally | |
443 | search_index: | |
444 | enabled: false | |
445 | # URL of the search index, that should use the same search API and routes | |
446 | # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html | |
447 | # You should deploy your own with https://framagit.org/framasoft/peertube/search-index, | |
448 | # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index | |
449 | url: '' | |
450 | # You can disable local search, so users only use the search index | |
451 | disable_local_search: false | |
452 | # If you did not disable local search, you can decide to use the search index by default | |
453 | is_default_search: false |