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