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