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