1 import { IConfig } from 'config'
2 import { dirname, join } from 'path'
3 import { VideosRedundancyStrategy } from '../../shared/models'
4 // Do not use barrels, remain constants as independent as possible
5 import { buildPath, parseBytes, parseDurationToMs, root } from '../helpers/core-utils'
6 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
7 import * as bytes from 'bytes'
8 import { VideoRedundancyConfigFilter } from '@shared/models/redundancy/video-redundancy-config-filter.type'
9 import { BroadcastMessageLevel } from '@shared/models/server'
11 // Use a variable to reload the configuration if we need
12 let config: IConfig = require('config')
14 const configChangedHandlers: Function[] = []
17 CUSTOM_FILE: getLocalConfigFilePath(),
19 PORT: config.get<number>('listen.port'),
20 HOSTNAME: config.get<string>('listen.hostname')
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'),
30 MAX: config.get<number>('database.pool.max')
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
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')
54 SIGNATURE: config.get<string>('email.body.signature')
57 PREFIX: config.get<string>('email.subject.prefix') + ' '
61 TMP_DIR: buildPath(config.get<string>('storage.tmp')),
62 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
63 LOG_DIR: buildPath(config.get<string>('storage.logs')),
64 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
65 STREAMING_PLAYLISTS_DIR: buildPath(config.get<string>('storage.streaming_playlists')),
66 REDUNDANCY_DIR: buildPath(config.get<string>('storage.redundancy')),
67 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
68 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
69 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
70 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
71 CACHE_DIR: buildPath(config.get<string>('storage.cache')),
72 PLUGINS_DIR: buildPath(config.get<string>('storage.plugins')),
73 CLIENT_OVERRIDES_DIR: buildPath(config.get<string>('storage.client_overrides'))
76 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
77 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
78 HOSTNAME: config.get<string>('webserver.hostname'),
79 PORT: config.get<number>('webserver.port')
83 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.api.window')),
84 MAX: config.get<number>('rates_limit.api.max')
87 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.signup.window')),
88 MAX: config.get<number>('rates_limit.signup.max')
91 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.login.window')),
92 MAX: config.get<number>('rates_limit.login.max')
95 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.ask_send_email.window')),
96 MAX: config.get<number>('rates_limit.ask_send_email.max')
99 TRUST_PROXY: config.get<string[]>('trust_proxy'),
101 LEVEL: config.get<string>('log.level'),
103 ENABLED: config.get<boolean>('log.rotation.enabled'),
104 MAX_FILE_SIZE: bytes.parse(config.get<string>('log.rotation.maxFileSize')),
105 MAX_FILES: config.get<number>('log.rotation.maxFiles')
107 ANONYMIZE_IP: config.get<boolean>('log.anonymizeIP'),
108 LOG_PING_REQUESTS: config.get<boolean>('log.log_ping_requests'),
109 PRETTIFY_SQL: config.get<boolean>('log.prettify_sql')
113 INTERVAL_DAYS: config.get<number>('trending.videos.interval_days')
118 CHECK_INTERVAL: parseDurationToMs(config.get<string>('redundancy.videos.check_interval')),
119 STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
124 ACCEPT_FROM: config.get<VideoRedundancyConfigFilter>('remote_redundancy.videos.accept_from')
128 ENABLED: config.get<boolean>('csp.enabled'),
129 REPORT_ONLY: config.get<boolean>('csp.report_only'),
130 REPORT_URI: config.get<string>('csp.report_uri')
133 ENABLED: config.get<boolean>('tracker.enabled'),
134 PRIVATE: config.get<boolean>('tracker.private'),
135 REJECT_TOO_MANY_ANNOUNCES: config.get<boolean>('tracker.reject_too_many_announces')
139 MAX_AGE: parseDurationToMs(config.get('history.videos.max_age'))
145 MAX_AGE: parseDurationToMs(config.get('views.videos.remote.max_age'))
151 ENABLED: config.get<boolean>('plugins.index.enabled'),
152 CHECK_LATEST_VERSIONS_INTERVAL: parseDurationToMs(config.get<string>('plugins.index.check_latest_versions_interval')),
153 URL: config.get<string>('plugins.index.url')
158 FEDERATE_UNLISTED: config.get<boolean>('federation.videos.federate_unlisted')
162 get EMAIL () { return config.get<string>('admin.email') }
165 get ENABLED () { return config.get<boolean>('contact_form.enabled') }
168 get ENABLED () { return config.get<boolean>('signup.enabled') },
169 get LIMIT () { return config.get<number>('signup.limit') },
170 get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
173 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
174 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
179 get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
180 get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
183 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
184 get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
185 get ALLOW_AUDIO_FILES () { return config.get<boolean>('transcoding.allow_audio_files') },
186 get THREADS () { return config.get<number>('transcoding.threads') },
188 get '0p' () { return config.get<boolean>('transcoding.resolutions.0p') },
189 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
190 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
191 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
192 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
193 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') },
194 get '1440p' () { return config.get<boolean>('transcoding.resolutions.1440p') },
195 get '2160p' () { return config.get<boolean>('transcoding.resolutions.2160p') }
198 get ENABLED () { return config.get<boolean>('transcoding.hls.enabled') }
201 get ENABLED () { return config.get<boolean>('transcoding.webtorrent.enabled') }
205 get ENABLED () { return config.get<boolean>('live.enabled') },
207 get MAX_DURATION () { return parseDurationToMs(config.get<string>('live.max_duration')) },
208 get MAX_INSTANCE_LIVES () { return config.get<number>('live.max_instance_lives') },
209 get MAX_USER_LIVES () { return config.get<number>('live.max_user_lives') },
211 get ALLOW_REPLAY () { return config.get<boolean>('live.allow_replay') },
214 get PORT () { return config.get<number>('live.rtmp.port') }
218 get ENABLED () { return config.get<boolean>('live.transcoding.enabled') },
219 get THREADS () { return config.get<number>('live.transcoding.threads') },
222 get '240p' () { return config.get<boolean>('live.transcoding.resolutions.240p') },
223 get '360p' () { return config.get<boolean>('live.transcoding.resolutions.360p') },
224 get '480p' () { return config.get<boolean>('live.transcoding.resolutions.480p') },
225 get '720p' () { return config.get<boolean>('live.transcoding.resolutions.720p') },
226 get '1080p' () { return config.get<boolean>('live.transcoding.resolutions.1080p') },
227 get '1440p' () { return config.get<boolean>('live.transcoding.resolutions.1440p') },
228 get '2160p' () { return config.get<boolean>('live.transcoding.resolutions.2160p') }
235 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') },
236 get FORCE_IPV4 () { return config.get<boolean>('import.videos.http.force_ipv4') },
238 get ENABLED () { return config.get<boolean>('import.videos.http.proxy.enabled') },
239 get URL () { return config.get<string>('import.videos.http.proxy.url') }
243 get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
250 get ENABLED () { return config.get<boolean>('auto_blacklist.videos.of_users.enabled') }
256 get SIZE () { return config.get<number>('cache.previews.size') }
259 get SIZE () { return config.get<number>('cache.captions.size') }
263 get NAME () { return config.get<string>('instance.name') },
264 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
265 get DESCRIPTION () { return config.get<string>('instance.description') },
266 get TERMS () { return config.get<string>('instance.terms') },
267 get CODE_OF_CONDUCT () { return config.get<string>('instance.code_of_conduct') },
269 get CREATION_REASON () { return config.get<string>('instance.creation_reason') },
271 get MODERATION_INFORMATION () { return config.get<string>('instance.moderation_information') },
272 get ADMINISTRATOR () { return config.get<string>('instance.administrator') },
273 get MAINTENANCE_LIFETIME () { return config.get<string>('instance.maintenance_lifetime') },
274 get BUSINESS_MODEL () { return config.get<string>('instance.business_model') },
275 get HARDWARE_INFORMATION () { return config.get<string>('instance.hardware_information') },
277 get LANGUAGES () { return config.get<string[]>('instance.languages') || [] },
278 get CATEGORIES () { return config.get<number[]>('instance.categories') || [] },
280 get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
281 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
282 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
284 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
285 get CSS () { return config.get<string>('instance.customizations.css') }
287 get ROBOTS () { return config.get<string>('instance.robots') },
288 get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
289 get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
293 get USERNAME () { return config.get<string>('services.twitter.username') },
294 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
299 get ENABLED () { return config.get<boolean>('followers.instance.enabled') },
300 get MANUAL_APPROVAL () { return config.get<boolean>('followers.instance.manual_approval') }
307 return config.get<boolean>('followings.instance.auto_follow_back.enabled')
312 return config.get<boolean>('followings.instance.auto_follow_index.enabled')
315 return config.get<string>('followings.instance.auto_follow_index.index_url')
321 get DEFAULT () { return config.get<string>('theme.default') }
324 get ENABLED () { return config.get<boolean>('broadcast_message.enabled') },
325 get MESSAGE () { return config.get<string>('broadcast_message.message') },
326 get LEVEL () { return config.get<BroadcastMessageLevel>('broadcast_message.level') },
327 get DISMISSABLE () { return config.get<boolean>('broadcast_message.dismissable') }
331 USERS: config.get<boolean>('search.remote_uri.users'),
332 ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous')
335 get ENABLED () { return config.get<boolean>('search.search_index.enabled') },
336 get URL () { return config.get<string>('search.search_index.url') },
337 get DISABLE_LOCAL_SEARCH () { return config.get<boolean>('search.search_index.disable_local_search') },
338 get IS_DEFAULT_SEARCH () { return config.get<boolean>('search.search_index.is_default_search') }
343 function registerConfigChangedHandler (fun: Function) {
344 configChangedHandlers.push(fun)
347 function isEmailEnabled () {
348 if (CONFIG.SMTP.TRANSPORT === 'sendmail' && CONFIG.SMTP.SENDMAIL) return true
350 if (CONFIG.SMTP.TRANSPORT === 'smtp' && CONFIG.SMTP.HOSTNAME && CONFIG.SMTP.PORT) return true
355 // ---------------------------------------------------------------------------
359 registerConfigChangedHandler,
363 // ---------------------------------------------------------------------------
365 function getLocalConfigFilePath () {
366 const configSources = config.util.getConfigSources()
367 if (configSources.length === 0) throw new Error('Invalid config source.')
369 let filename = 'local'
370 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
371 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
373 return join(dirname(configSources[0].name), filename + '.json')
376 function buildVideosRedundancy (objs: any[]): VideosRedundancyStrategy[] {
379 if (!Array.isArray(objs)) return objs
381 return objs.map(obj => {
382 return Object.assign({}, obj, {
383 minLifetime: parseDurationToMs(obj.min_lifetime),
384 size: bytes.parse(obj.size),
385 minViews: obj.min_views
390 export function reloadConfig () {
392 function directory () {
393 if (process.env.NODE_CONFIG_DIR) {
394 return process.env.NODE_CONFIG_DIR
397 return join(root(), 'config')
401 for (const fileName in require.cache) {
402 if (fileName.includes(directory()) === false) {
406 delete require.cache[fileName]
409 delete require.cache[require.resolve('config')]
414 config = require('config')
416 for (const configChangedHandler of configChangedHandlers) {
417 configChangedHandler()