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: 'peertube' + config.get<string>('database.suffix'),
24 HOSTNAME: config.get<string>('database.hostname'),
25 PORT: config.get<number>('database.port'),
26 USERNAME: config.get<string>('database.username'),
27 PASSWORD: config.get<string>('database.password'),
29 MAX: config.get<number>('database.pool.max')
33 HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
34 PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
35 SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
36 AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
37 DB: config.has('redis.db') ? config.get<number>('redis.db') : null
40 TRANSPORT: config.has('smtp.transport') ? config.get<string>('smtp.transport') : 'smtp',
41 SENDMAIL: config.has('smtp.sendmail') ? config.get<string>('smtp.sendmail') : null,
42 HOSTNAME: config.get<string>('smtp.hostname'),
43 PORT: config.get<number>('smtp.port'),
44 USERNAME: config.get<string>('smtp.username'),
45 PASSWORD: config.get<string>('smtp.password'),
46 TLS: config.get<boolean>('smtp.tls'),
47 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
48 CA_FILE: config.get<string>('smtp.ca_file'),
49 FROM_ADDRESS: config.get<string>('smtp.from_address')
53 SIGNATURE: config.get<string>('email.body.signature')
56 PREFIX: config.get<string>('email.subject.prefix') + ' '
60 TMP_DIR: buildPath(config.get<string>('storage.tmp')),
61 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
62 LOG_DIR: buildPath(config.get<string>('storage.logs')),
63 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
64 STREAMING_PLAYLISTS_DIR: buildPath(config.get<string>('storage.streaming_playlists')),
65 REDUNDANCY_DIR: buildPath(config.get<string>('storage.redundancy')),
66 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
67 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
68 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
69 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
70 CACHE_DIR: buildPath(config.get<string>('storage.cache')),
71 PLUGINS_DIR: buildPath(config.get<string>('storage.plugins'))
74 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
75 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
76 HOSTNAME: config.get<string>('webserver.hostname'),
77 PORT: config.get<number>('webserver.port')
81 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.api.window')),
82 MAX: config.get<number>('rates_limit.api.max')
85 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.signup.window')),
86 MAX: config.get<number>('rates_limit.signup.max')
89 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.login.window')),
90 MAX: config.get<number>('rates_limit.login.max')
93 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.ask_send_email.window')),
94 MAX: config.get<number>('rates_limit.ask_send_email.max')
97 TRUST_PROXY: config.get<string[]>('trust_proxy'),
99 LEVEL: config.get<string>('log.level'),
101 ENABLED: config.get<boolean>('log.rotation.enabled'),
102 MAX_FILE_SIZE: bytes.parse(config.get<string>('log.rotation.maxFileSize')),
103 MAX_FILES: config.get<number>('log.rotation.maxFiles')
105 ANONYMIZE_IP: config.get<boolean>('log.anonymizeIP')
109 INTERVAL_DAYS: config.get<number>('trending.videos.interval_days')
114 CHECK_INTERVAL: parseDurationToMs(config.get<string>('redundancy.videos.check_interval')),
115 STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
120 ACCEPT_FROM: config.get<VideoRedundancyConfigFilter>('remote_redundancy.videos.accept_from')
124 ENABLED: config.get<boolean>('csp.enabled'),
125 REPORT_ONLY: config.get<boolean>('csp.report_only'),
126 REPORT_URI: config.get<boolean>('csp.report_uri')
129 ENABLED: config.get<boolean>('tracker.enabled'),
130 PRIVATE: config.get<boolean>('tracker.private'),
131 REJECT_TOO_MANY_ANNOUNCES: config.get<boolean>('tracker.reject_too_many_announces')
135 MAX_AGE: parseDurationToMs(config.get('history.videos.max_age'))
141 MAX_AGE: parseDurationToMs(config.get('views.videos.remote.max_age'))
147 ENABLED: config.get<boolean>('plugins.index.enabled'),
148 CHECK_LATEST_VERSIONS_INTERVAL: parseDurationToMs(config.get<string>('plugins.index.check_latest_versions_interval')),
149 URL: config.get<string>('plugins.index.url')
154 FEDERATE_UNLISTED: config.get<boolean>('federation.videos.federate_unlisted')
158 get EMAIL () { return config.get<string>('admin.email') }
161 get ENABLED () { return config.get<boolean>('contact_form.enabled') }
164 get ENABLED () { return config.get<boolean>('signup.enabled') },
165 get LIMIT () { return config.get<number>('signup.limit') },
166 get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
169 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
170 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
175 get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
176 get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
179 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
180 get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
181 get ALLOW_AUDIO_FILES () { return config.get<boolean>('transcoding.allow_audio_files') },
182 get THREADS () { return config.get<number>('transcoding.threads') },
184 get '0p' () { return config.get<boolean>('transcoding.resolutions.0p') },
185 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
186 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
187 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
188 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
189 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') },
190 get '2160p' () { return config.get<boolean>('transcoding.resolutions.2160p') }
193 get ENABLED () { return config.get<boolean>('transcoding.hls.enabled') }
196 get ENABLED () { return config.get<boolean>('transcoding.webtorrent.enabled') }
202 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') },
204 get ENABLED () { return config.get<boolean>('import.videos.http.proxy.enabled') },
205 get URL () { return config.get<string>('import.videos.http.proxy.url') }
209 get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
216 get ENABLED () { return config.get<boolean>('auto_blacklist.videos.of_users.enabled') }
222 get SIZE () { return config.get<number>('cache.previews.size') }
225 get SIZE () { return config.get<number>('cache.captions.size') }
229 get NAME () { return config.get<string>('instance.name') },
230 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
231 get DESCRIPTION () { return config.get<string>('instance.description') },
232 get TERMS () { return config.get<string>('instance.terms') },
233 get CODE_OF_CONDUCT () { return config.get<string>('instance.code_of_conduct') },
235 get CREATION_REASON () { return config.get<string>('instance.creation_reason') },
237 get MODERATION_INFORMATION () { return config.get<string>('instance.moderation_information') },
238 get ADMINISTRATOR () { return config.get<string>('instance.administrator') },
239 get MAINTENANCE_LIFETIME () { return config.get<string>('instance.maintenance_lifetime') },
240 get BUSINESS_MODEL () { return config.get<string>('instance.business_model') },
241 get HARDWARE_INFORMATION () { return config.get<string>('instance.hardware_information') },
243 get LANGUAGES () { return config.get<string[]>('instance.languages') || [] },
244 get CATEGORIES () { return config.get<number[]>('instance.categories') || [] },
246 get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
247 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
248 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
250 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
251 get CSS () { return config.get<string>('instance.customizations.css') }
253 get ROBOTS () { return config.get<string>('instance.robots') },
254 get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
255 get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
259 get USERNAME () { return config.get<string>('services.twitter.username') },
260 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
265 get ENABLED () { return config.get<boolean>('followers.instance.enabled') },
266 get MANUAL_APPROVAL () { return config.get<boolean>('followers.instance.manual_approval') }
273 return config.get<boolean>('followings.instance.auto_follow_back.enabled')
278 return config.get<boolean>('followings.instance.auto_follow_index.enabled')
281 return config.get<string>('followings.instance.auto_follow_index.index_url')
287 get DEFAULT () { return config.get<string>('theme.default') }
290 get ENABLED () { return config.get<boolean>('broadcast_message.enabled') },
291 get MESSAGE () { return config.get<string>('broadcast_message.message') },
292 get LEVEL () { return config.get<BroadcastMessageLevel>('broadcast_message.level') },
293 get DISMISSABLE () { return config.get<boolean>('broadcast_message.dismissable') }
297 USERS: config.get<boolean>('search.remote_uri.users'),
298 ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous')
301 get ENABLED () { return config.get<boolean>('search.search_index.enabled') },
302 get URL () { return config.get<string>('search.search_index.url') },
303 get DISABLE_LOCAL_SEARCH () { return config.get<boolean>('search.search_index.disable_local_search') },
304 get IS_DEFAULT_SEARCH () { return config.get<boolean>('search.search_index.is_default_search') }
309 function registerConfigChangedHandler (fun: Function) {
310 configChangedHandlers.push(fun)
313 function isEmailEnabled () {
314 return !!CONFIG.SMTP.HOSTNAME && !!CONFIG.SMTP.PORT
317 // ---------------------------------------------------------------------------
321 registerConfigChangedHandler,
325 // ---------------------------------------------------------------------------
327 function getLocalConfigFilePath () {
328 const configSources = config.util.getConfigSources()
329 if (configSources.length === 0) throw new Error('Invalid config source.')
331 let filename = 'local'
332 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
333 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
335 return join(dirname(configSources[0].name), filename + '.json')
338 function buildVideosRedundancy (objs: any[]): VideosRedundancyStrategy[] {
341 if (!Array.isArray(objs)) return objs
343 return objs.map(obj => {
344 return Object.assign({}, obj, {
345 minLifetime: parseDurationToMs(obj.min_lifetime),
346 size: bytes.parse(obj.size),
347 minViews: obj.min_views
352 export function reloadConfig () {
354 function directory () {
355 if (process.env.NODE_CONFIG_DIR) {
356 return process.env.NODE_CONFIG_DIR
359 return join(root(), 'config')
363 for (const fileName in require.cache) {
364 if (fileName.includes(directory()) === false) {
368 delete require.cache[fileName]
371 delete require.cache[require.resolve('config')]
376 config = require('config')
378 for (const configChangedHandler of configChangedHandlers) {
379 configChangedHandler()