]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blob - server/initializers/config.ts
a6ea6d888230d2d29903b79e00ba904453ff23c4
[github/Chocobozzz/PeerTube.git] / server / initializers / config.ts
1 import bytes from 'bytes'
2 import { IConfig } from 'config'
3 import { dirname, join } from 'path'
4 import { decacheModule } from '@server/helpers/decache'
5 import { VideoRedundancyConfigFilter } from '@shared/models/redundancy/video-redundancy-config-filter.type'
6 import { BroadcastMessageLevel } from '@shared/models/server'
7 import { VideoPrivacy, VideosRedundancyStrategy } from '../../shared/models'
8 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
9 import { buildPath, root } from '../../shared/core-utils'
10 import { parseBytes, parseDurationToMs } from '../helpers/core-utils'
11
12 // Use a variable to reload the configuration if we need
13 let config: IConfig = require('config')
14
15 const configChangedHandlers: Function[] = []
16
17 const CONFIG = {
18 CUSTOM_FILE: getLocalConfigFilePath(),
19 LISTEN: {
20 PORT: config.get<number>('listen.port'),
21 HOSTNAME: config.get<string>('listen.hostname')
22 },
23 DATABASE: {
24 DBNAME: config.has('database.name') ? config.get<string>('database.name') : 'peertube' + config.get<string>('database.suffix'),
25 HOSTNAME: config.get<string>('database.hostname'),
26 PORT: config.get<number>('database.port'),
27 SSL: config.get<boolean>('database.ssl'),
28 USERNAME: config.get<string>('database.username'),
29 PASSWORD: config.get<string>('database.password'),
30 POOL: {
31 MAX: config.get<number>('database.pool.max')
32 }
33 },
34 REDIS: {
35 HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
36 PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
37 SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
38 AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
39 DB: config.has('redis.db') ? config.get<number>('redis.db') : null
40 },
41 SMTP: {
42 TRANSPORT: config.has('smtp.transport') ? config.get<string>('smtp.transport') : 'smtp',
43 SENDMAIL: config.has('smtp.sendmail') ? config.get<string>('smtp.sendmail') : null,
44 HOSTNAME: config.get<string>('smtp.hostname'),
45 PORT: config.get<number>('smtp.port'),
46 USERNAME: config.get<string>('smtp.username'),
47 PASSWORD: config.get<string>('smtp.password'),
48 TLS: config.get<boolean>('smtp.tls'),
49 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
50 CA_FILE: config.get<string>('smtp.ca_file'),
51 FROM_ADDRESS: config.get<string>('smtp.from_address')
52 },
53 EMAIL: {
54 BODY: {
55 SIGNATURE: config.get<string>('email.body.signature')
56 },
57 SUBJECT: {
58 PREFIX: config.get<string>('email.subject.prefix') + ' '
59 }
60 },
61
62 CLIENT: {
63 VIDEOS: {
64 MINIATURE: {
65 get PREFER_AUTHOR_DISPLAY_NAME () { return config.get<boolean>('client.videos.miniature.prefer_author_display_name') }
66 }
67 },
68 MENU: {
69 LOGIN: {
70 get REDIRECT_ON_SINGLE_EXTERNAL_AUTH () { return config.get<boolean>('client.menu.login.redirect_on_single_external_auth') }
71 }
72 }
73 },
74
75 DEFAULTS: {
76 PUBLISH: {
77 DOWNLOAD_ENABLED: config.get<boolean>('defaults.publish.download_enabled'),
78 COMMENTS_ENABLED: config.get<boolean>('defaults.publish.comments_enabled'),
79 PRIVACY: config.get<VideoPrivacy>('defaults.publish.privacy'),
80 LICENCE: config.get<number>('defaults.publish.licence')
81 },
82 P2P: {
83 ENABLED: config.get<boolean>('defaults.p2p.enabled')
84 }
85 },
86
87 STORAGE: {
88 TMP_DIR: buildPath(config.get<string>('storage.tmp')),
89 BIN_DIR: buildPath(config.get<string>('storage.bin')),
90 ACTOR_IMAGES: buildPath(config.get<string>('storage.avatars')),
91 LOG_DIR: buildPath(config.get<string>('storage.logs')),
92 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
93 STREAMING_PLAYLISTS_DIR: buildPath(config.get<string>('storage.streaming_playlists')),
94 REDUNDANCY_DIR: buildPath(config.get<string>('storage.redundancy')),
95 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
96 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
97 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
98 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
99 CACHE_DIR: buildPath(config.get<string>('storage.cache')),
100 PLUGINS_DIR: buildPath(config.get<string>('storage.plugins')),
101 CLIENT_OVERRIDES_DIR: buildPath(config.get<string>('storage.client_overrides'))
102 },
103 OBJECT_STORAGE: {
104 ENABLED: config.get<boolean>('object_storage.enabled'),
105 MAX_UPLOAD_PART: bytes.parse(config.get<string>('object_storage.max_upload_part')),
106 ENDPOINT: config.get<string>('object_storage.endpoint'),
107 REGION: config.get<string>('object_storage.region'),
108 CREDENTIALS: {
109 ACCESS_KEY_ID: config.get<string>('object_storage.credentials.access_key_id'),
110 SECRET_ACCESS_KEY: config.get<string>('object_storage.credentials.secret_access_key')
111 },
112 VIDEOS: {
113 BUCKET_NAME: config.get<string>('object_storage.videos.bucket_name'),
114 PREFIX: config.get<string>('object_storage.videos.prefix'),
115 BASE_URL: config.get<string>('object_storage.videos.base_url')
116 },
117 STREAMING_PLAYLISTS: {
118 BUCKET_NAME: config.get<string>('object_storage.streaming_playlists.bucket_name'),
119 PREFIX: config.get<string>('object_storage.streaming_playlists.prefix'),
120 BASE_URL: config.get<string>('object_storage.streaming_playlists.base_url')
121 }
122 },
123 WEBSERVER: {
124 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
125 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
126 HOSTNAME: config.get<string>('webserver.hostname'),
127 PORT: config.get<number>('webserver.port')
128 },
129 RATES_LIMIT: {
130 API: {
131 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.api.window')),
132 MAX: config.get<number>('rates_limit.api.max')
133 },
134 SIGNUP: {
135 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.signup.window')),
136 MAX: config.get<number>('rates_limit.signup.max')
137 },
138 LOGIN: {
139 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.login.window')),
140 MAX: config.get<number>('rates_limit.login.max')
141 },
142 ASK_SEND_EMAIL: {
143 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.ask_send_email.window')),
144 MAX: config.get<number>('rates_limit.ask_send_email.max')
145 }
146 },
147 TRUST_PROXY: config.get<string[]>('trust_proxy'),
148 LOG: {
149 LEVEL: config.get<string>('log.level'),
150 ROTATION: {
151 ENABLED: config.get<boolean>('log.rotation.enabled'),
152 MAX_FILE_SIZE: bytes.parse(config.get<string>('log.rotation.max_file_size')),
153 MAX_FILES: config.get<number>('log.rotation.max_files')
154 },
155 ANONYMIZE_IP: config.get<boolean>('log.anonymize_ip'),
156 LOG_PING_REQUESTS: config.get<boolean>('log.log_ping_requests'),
157 PRETTIFY_SQL: config.get<boolean>('log.prettify_sql')
158 },
159 TRENDING: {
160 VIDEOS: {
161 INTERVAL_DAYS: config.get<number>('trending.videos.interval_days'),
162 ALGORITHMS: {
163 get ENABLED () { return config.get<string[]>('trending.videos.algorithms.enabled') },
164 get DEFAULT () { return config.get<string>('trending.videos.algorithms.default') }
165 }
166 }
167 },
168 REDUNDANCY: {
169 VIDEOS: {
170 CHECK_INTERVAL: parseDurationToMs(config.get<string>('redundancy.videos.check_interval')),
171 STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
172 }
173 },
174 REMOTE_REDUNDANCY: {
175 VIDEOS: {
176 ACCEPT_FROM: config.get<VideoRedundancyConfigFilter>('remote_redundancy.videos.accept_from')
177 }
178 },
179 CSP: {
180 ENABLED: config.get<boolean>('csp.enabled'),
181 REPORT_ONLY: config.get<boolean>('csp.report_only'),
182 REPORT_URI: config.get<string>('csp.report_uri')
183 },
184 SECURITY: {
185 FRAMEGUARD: {
186 ENABLED: config.get<boolean>('security.frameguard.enabled')
187 }
188 },
189 TRACKER: {
190 ENABLED: config.get<boolean>('tracker.enabled'),
191 PRIVATE: config.get<boolean>('tracker.private'),
192 REJECT_TOO_MANY_ANNOUNCES: config.get<boolean>('tracker.reject_too_many_announces')
193 },
194 HISTORY: {
195 VIDEOS: {
196 MAX_AGE: parseDurationToMs(config.get('history.videos.max_age'))
197 }
198 },
199 VIEWS: {
200 VIDEOS: {
201 REMOTE: {
202 MAX_AGE: parseDurationToMs(config.get('views.videos.remote.max_age'))
203 },
204 LOCAL_BUFFER_UPDATE_INTERVAL: parseDurationToMs(config.get('views.videos.local_buffer_update_interval')),
205 IP_VIEW_EXPIRATION: parseDurationToMs(config.get('views.videos.ip_view_expiration'))
206 }
207 },
208 PLUGINS: {
209 INDEX: {
210 ENABLED: config.get<boolean>('plugins.index.enabled'),
211 CHECK_LATEST_VERSIONS_INTERVAL: parseDurationToMs(config.get<string>('plugins.index.check_latest_versions_interval')),
212 URL: config.get<string>('plugins.index.url')
213 }
214 },
215 FEDERATION: {
216 VIDEOS: {
217 FEDERATE_UNLISTED: config.get<boolean>('federation.videos.federate_unlisted'),
218 CLEANUP_REMOTE_INTERACTIONS: config.get<boolean>('federation.videos.cleanup_remote_interactions')
219 }
220 },
221 PEERTUBE: {
222 CHECK_LATEST_VERSION: {
223 ENABLED: config.get<boolean>('peertube.check_latest_version.enabled'),
224 URL: config.get<string>('peertube.check_latest_version.url')
225 }
226 },
227 WEBADMIN: {
228 CONFIGURATION: {
229 EDITION: {
230 ALLOWED: config.get<boolean>('webadmin.configuration.edition.allowed')
231 }
232 }
233 },
234 ADMIN: {
235 get EMAIL () { return config.get<string>('admin.email') }
236 },
237 CONTACT_FORM: {
238 get ENABLED () { return config.get<boolean>('contact_form.enabled') }
239 },
240 SIGNUP: {
241 get ENABLED () { return config.get<boolean>('signup.enabled') },
242 get LIMIT () { return config.get<number>('signup.limit') },
243 get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
244 get MINIMUM_AGE () { return config.get<number>('signup.minimum_age') },
245 FILTERS: {
246 CIDR: {
247 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
248 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
249 }
250 }
251 },
252 USER: {
253 get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
254 get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
255 },
256 VIDEO_CHANNELS: {
257 get MAX_PER_USER () { return config.get<number>('video_channels.max_per_user') }
258 },
259 TRANSCODING: {
260 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
261 get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
262 get ALLOW_AUDIO_FILES () { return config.get<boolean>('transcoding.allow_audio_files') },
263 get THREADS () { return config.get<number>('transcoding.threads') },
264 get CONCURRENCY () { return config.get<number>('transcoding.concurrency') },
265 get PROFILE () { return config.get<string>('transcoding.profile') },
266 RESOLUTIONS: {
267 get '0p' () { return config.get<boolean>('transcoding.resolutions.0p') },
268 get '144p' () { return config.get<boolean>('transcoding.resolutions.144p') },
269 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
270 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
271 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
272 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
273 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') },
274 get '1440p' () { return config.get<boolean>('transcoding.resolutions.1440p') },
275 get '2160p' () { return config.get<boolean>('transcoding.resolutions.2160p') }
276 },
277 HLS: {
278 get ENABLED () { return config.get<boolean>('transcoding.hls.enabled') }
279 },
280 WEBTORRENT: {
281 get ENABLED () { return config.get<boolean>('transcoding.webtorrent.enabled') }
282 }
283 },
284 LIVE: {
285 get ENABLED () { return config.get<boolean>('live.enabled') },
286
287 get MAX_DURATION () { return parseDurationToMs(config.get<string>('live.max_duration')) },
288 get MAX_INSTANCE_LIVES () { return config.get<number>('live.max_instance_lives') },
289 get MAX_USER_LIVES () { return config.get<number>('live.max_user_lives') },
290
291 get ALLOW_REPLAY () { return config.get<boolean>('live.allow_replay') },
292
293 RTMP: {
294 get ENABLED () { return config.get<boolean>('live.rtmp.enabled') },
295 get PORT () { return config.get<number>('live.rtmp.port') }
296 },
297
298 RTMPS: {
299 get ENABLED () { return config.get<boolean>('live.rtmps.enabled') },
300 get PORT () { return config.get<number>('live.rtmps.port') },
301 get KEY_FILE () { return config.get<string>('live.rtmps.key_file') },
302 get CERT_FILE () { return config.get<string>('live.rtmps.cert_file') }
303 },
304
305 TRANSCODING: {
306 get ENABLED () { return config.get<boolean>('live.transcoding.enabled') },
307 get THREADS () { return config.get<number>('live.transcoding.threads') },
308 get PROFILE () { return config.get<string>('live.transcoding.profile') },
309
310 RESOLUTIONS: {
311 get '144p' () { return config.get<boolean>('live.transcoding.resolutions.144p') },
312 get '240p' () { return config.get<boolean>('live.transcoding.resolutions.240p') },
313 get '360p' () { return config.get<boolean>('live.transcoding.resolutions.360p') },
314 get '480p' () { return config.get<boolean>('live.transcoding.resolutions.480p') },
315 get '720p' () { return config.get<boolean>('live.transcoding.resolutions.720p') },
316 get '1080p' () { return config.get<boolean>('live.transcoding.resolutions.1080p') },
317 get '1440p' () { return config.get<boolean>('live.transcoding.resolutions.1440p') },
318 get '2160p' () { return config.get<boolean>('live.transcoding.resolutions.2160p') }
319 }
320 }
321 },
322 IMPORT: {
323 VIDEOS: {
324 get CONCURRENCY () { return config.get<number>('import.videos.concurrency') },
325
326 HTTP: {
327 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') },
328
329 YOUTUBE_DL_RELEASE: {
330 get URL () { return config.get<string>('import.videos.http.youtube_dl_release.url') },
331 get NAME () { return config.get<string>('import.videos.http.youtube_dl_release.name') }
332 },
333
334 get FORCE_IPV4 () { return config.get<boolean>('import.videos.http.force_ipv4') }
335 },
336 TORRENT: {
337 get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
338 }
339 }
340 },
341 AUTO_BLACKLIST: {
342 VIDEOS: {
343 OF_USERS: {
344 get ENABLED () { return config.get<boolean>('auto_blacklist.videos.of_users.enabled') }
345 }
346 }
347 },
348 CACHE: {
349 PREVIEWS: {
350 get SIZE () { return config.get<number>('cache.previews.size') }
351 },
352 VIDEO_CAPTIONS: {
353 get SIZE () { return config.get<number>('cache.captions.size') }
354 },
355 TORRENTS: {
356 get SIZE () { return config.get<number>('cache.torrents.size') }
357 }
358 },
359 INSTANCE: {
360 get NAME () { return config.get<string>('instance.name') },
361 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
362 get DESCRIPTION () { return config.get<string>('instance.description') },
363 get TERMS () { return config.get<string>('instance.terms') },
364 get CODE_OF_CONDUCT () { return config.get<string>('instance.code_of_conduct') },
365
366 get CREATION_REASON () { return config.get<string>('instance.creation_reason') },
367
368 get MODERATION_INFORMATION () { return config.get<string>('instance.moderation_information') },
369 get ADMINISTRATOR () { return config.get<string>('instance.administrator') },
370 get MAINTENANCE_LIFETIME () { return config.get<string>('instance.maintenance_lifetime') },
371 get BUSINESS_MODEL () { return config.get<string>('instance.business_model') },
372 get HARDWARE_INFORMATION () { return config.get<string>('instance.hardware_information') },
373
374 get LANGUAGES () { return config.get<string[]>('instance.languages') || [] },
375 get CATEGORIES () { return config.get<number[]>('instance.categories') || [] },
376
377 get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
378 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
379
380 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
381
382 CUSTOMIZATIONS: {
383 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
384 get CSS () { return config.get<string>('instance.customizations.css') }
385 },
386 get ROBOTS () { return config.get<string>('instance.robots') },
387 get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
388 get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
389 },
390 SERVICES: {
391 TWITTER: {
392 get USERNAME () { return config.get<string>('services.twitter.username') },
393 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
394 }
395 },
396 FOLLOWERS: {
397 INSTANCE: {
398 get ENABLED () { return config.get<boolean>('followers.instance.enabled') },
399 get MANUAL_APPROVAL () { return config.get<boolean>('followers.instance.manual_approval') }
400 }
401 },
402 FOLLOWINGS: {
403 INSTANCE: {
404 AUTO_FOLLOW_BACK: {
405 get ENABLED () {
406 return config.get<boolean>('followings.instance.auto_follow_back.enabled')
407 }
408 },
409 AUTO_FOLLOW_INDEX: {
410 get ENABLED () {
411 return config.get<boolean>('followings.instance.auto_follow_index.enabled')
412 },
413 get INDEX_URL () {
414 return config.get<string>('followings.instance.auto_follow_index.index_url')
415 }
416 }
417 }
418 },
419 THEME: {
420 get DEFAULT () { return config.get<string>('theme.default') }
421 },
422 BROADCAST_MESSAGE: {
423 get ENABLED () { return config.get<boolean>('broadcast_message.enabled') },
424 get MESSAGE () { return config.get<string>('broadcast_message.message') },
425 get LEVEL () { return config.get<BroadcastMessageLevel>('broadcast_message.level') },
426 get DISMISSABLE () { return config.get<boolean>('broadcast_message.dismissable') }
427 },
428 SEARCH: {
429 REMOTE_URI: {
430 get USERS () { return config.get<boolean>('search.remote_uri.users') },
431 get ANONYMOUS () { return config.get<boolean>('search.remote_uri.anonymous') }
432 },
433 SEARCH_INDEX: {
434 get ENABLED () { return config.get<boolean>('search.search_index.enabled') },
435 get URL () { return config.get<string>('search.search_index.url') },
436 get DISABLE_LOCAL_SEARCH () { return config.get<boolean>('search.search_index.disable_local_search') },
437 get IS_DEFAULT_SEARCH () { return config.get<boolean>('search.search_index.is_default_search') }
438 }
439 }
440 }
441
442 function registerConfigChangedHandler (fun: Function) {
443 configChangedHandlers.push(fun)
444 }
445
446 function isEmailEnabled () {
447 if (CONFIG.SMTP.TRANSPORT === 'sendmail' && CONFIG.SMTP.SENDMAIL) return true
448
449 if (CONFIG.SMTP.TRANSPORT === 'smtp' && CONFIG.SMTP.HOSTNAME && CONFIG.SMTP.PORT) return true
450
451 return false
452 }
453
454 // ---------------------------------------------------------------------------
455
456 export {
457 CONFIG,
458 registerConfigChangedHandler,
459 isEmailEnabled
460 }
461
462 // ---------------------------------------------------------------------------
463
464 function getLocalConfigFilePath () {
465 const localConfigDir = getLocalConfigDir()
466
467 let filename = 'local'
468 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
469 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
470
471 return join(localConfigDir, filename + '.json')
472 }
473
474 function getLocalConfigDir () {
475 if (process.env.PEERTUBE_LOCAL_CONFIG) return process.env.PEERTUBE_LOCAL_CONFIG
476
477 const configSources = config.util.getConfigSources()
478 if (configSources.length === 0) throw new Error('Invalid config source.')
479
480 return dirname(configSources[0].name)
481 }
482
483 function buildVideosRedundancy (objs: any[]): VideosRedundancyStrategy[] {
484 if (!objs) return []
485
486 if (!Array.isArray(objs)) return objs
487
488 return objs.map(obj => {
489 return Object.assign({}, obj, {
490 minLifetime: parseDurationToMs(obj.min_lifetime),
491 size: bytes.parse(obj.size),
492 minViews: obj.min_views
493 })
494 })
495 }
496
497 export function reloadConfig () {
498
499 function getConfigDirectories () {
500 if (process.env.NODE_CONFIG_DIR) {
501 return process.env.NODE_CONFIG_DIR.split(':')
502 }
503
504 return [ join(root(), 'config') ]
505 }
506
507 function purge () {
508 const directories = getConfigDirectories()
509
510 for (const fileName in require.cache) {
511 if (directories.some((dir) => fileName.includes(dir)) === false) {
512 continue
513 }
514
515 delete require.cache[fileName]
516 }
517
518 decacheModule('config')
519 }
520
521 purge()
522
523 config = require('config')
524
525 for (const configChangedHandler of configChangedHandlers) {
526 configChangedHandler()
527 }
528 }