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