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