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'
12 // Use a variable to reload the configuration if we need
13 let config: IConfig = require('config')
15 const configChangedHandlers: Function[] = []
18 CUSTOM_FILE: getLocalConfigFilePath(),
20 PORT: config.get<number>('listen.port'),
21 HOSTNAME: config.get<string>('listen.hostname')
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'),
31 MAX: config.get<number>('database.pool.max')
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
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')
55 SIGNATURE: config.get<string>('email.body.signature')
58 PREFIX: config.get<string>('email.subject.prefix') + ' '
65 get PREFER_AUTHOR_DISPLAY_NAME () { return config.get<boolean>('client.videos.miniature.prefer_author_display_name') }
70 get REDIRECT_ON_SINGLE_EXTERNAL_AUTH () { return config.get<boolean>('client.menu.login.redirect_on_single_external_auth') }
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')
85 TMP_DIR: buildPath(config.get<string>('storage.tmp')),
86 BIN_DIR: buildPath(config.get<string>('storage.bin')),
87 ACTOR_IMAGES: buildPath(config.get<string>('storage.avatars')),
88 LOG_DIR: buildPath(config.get<string>('storage.logs')),
89 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
90 STREAMING_PLAYLISTS_DIR: buildPath(config.get<string>('storage.streaming_playlists')),
91 REDUNDANCY_DIR: buildPath(config.get<string>('storage.redundancy')),
92 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
93 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
94 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
95 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
96 CACHE_DIR: buildPath(config.get<string>('storage.cache')),
97 PLUGINS_DIR: buildPath(config.get<string>('storage.plugins')),
98 CLIENT_OVERRIDES_DIR: buildPath(config.get<string>('storage.client_overrides'))
101 ENABLED: config.get<boolean>('object_storage.enabled'),
102 MAX_UPLOAD_PART: bytes.parse(config.get<string>('object_storage.max_upload_part')),
103 ENDPOINT: config.get<string>('object_storage.endpoint'),
104 REGION: config.get<string>('object_storage.region'),
106 ACCESS_KEY_ID: config.get<string>('object_storage.credentials.access_key_id'),
107 SECRET_ACCESS_KEY: config.get<string>('object_storage.credentials.secret_access_key')
110 BUCKET_NAME: config.get<string>('object_storage.videos.bucket_name'),
111 PREFIX: config.get<string>('object_storage.videos.prefix'),
112 BASE_URL: config.get<string>('object_storage.videos.base_url')
114 STREAMING_PLAYLISTS: {
115 BUCKET_NAME: config.get<string>('object_storage.streaming_playlists.bucket_name'),
116 PREFIX: config.get<string>('object_storage.streaming_playlists.prefix'),
117 BASE_URL: config.get<string>('object_storage.streaming_playlists.base_url')
121 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
122 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
123 HOSTNAME: config.get<string>('webserver.hostname'),
124 PORT: config.get<number>('webserver.port')
128 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.api.window')),
129 MAX: config.get<number>('rates_limit.api.max')
132 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.signup.window')),
133 MAX: config.get<number>('rates_limit.signup.max')
136 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.login.window')),
137 MAX: config.get<number>('rates_limit.login.max')
140 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.ask_send_email.window')),
141 MAX: config.get<number>('rates_limit.ask_send_email.max')
144 TRUST_PROXY: config.get<string[]>('trust_proxy'),
146 LEVEL: config.get<string>('log.level'),
148 ENABLED: config.get<boolean>('log.rotation.enabled'),
149 MAX_FILE_SIZE: bytes.parse(config.get<string>('log.rotation.max_file_size')),
150 MAX_FILES: config.get<number>('log.rotation.max_files')
152 ANONYMIZE_IP: config.get<boolean>('log.anonymize_ip'),
153 LOG_PING_REQUESTS: config.get<boolean>('log.log_ping_requests'),
154 PRETTIFY_SQL: config.get<boolean>('log.prettify_sql')
158 INTERVAL_DAYS: config.get<number>('trending.videos.interval_days'),
160 get ENABLED () { return config.get<string[]>('trending.videos.algorithms.enabled') },
161 get DEFAULT () { return config.get<string>('trending.videos.algorithms.default') }
167 CHECK_INTERVAL: parseDurationToMs(config.get<string>('redundancy.videos.check_interval')),
168 STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
173 ACCEPT_FROM: config.get<VideoRedundancyConfigFilter>('remote_redundancy.videos.accept_from')
177 ENABLED: config.get<boolean>('csp.enabled'),
178 REPORT_ONLY: config.get<boolean>('csp.report_only'),
179 REPORT_URI: config.get<string>('csp.report_uri')
183 ENABLED: config.get<boolean>('security.frameguard.enabled')
187 ENABLED: config.get<boolean>('tracker.enabled'),
188 PRIVATE: config.get<boolean>('tracker.private'),
189 REJECT_TOO_MANY_ANNOUNCES: config.get<boolean>('tracker.reject_too_many_announces')
193 MAX_AGE: parseDurationToMs(config.get('history.videos.max_age'))
199 MAX_AGE: parseDurationToMs(config.get('views.videos.remote.max_age'))
201 LOCAL_BUFFER_UPDATE_INTERVAL: parseDurationToMs(config.get('views.videos.local_buffer_update_interval')),
202 IP_VIEW_EXPIRATION: parseDurationToMs(config.get('views.videos.ip_view_expiration'))
207 ENABLED: config.get<boolean>('plugins.index.enabled'),
208 CHECK_LATEST_VERSIONS_INTERVAL: parseDurationToMs(config.get<string>('plugins.index.check_latest_versions_interval')),
209 URL: config.get<string>('plugins.index.url')
214 FEDERATE_UNLISTED: config.get<boolean>('federation.videos.federate_unlisted'),
215 CLEANUP_REMOTE_INTERACTIONS: config.get<boolean>('federation.videos.cleanup_remote_interactions')
219 CHECK_LATEST_VERSION: {
220 ENABLED: config.get<boolean>('peertube.check_latest_version.enabled'),
221 URL: config.get<string>('peertube.check_latest_version.url')
227 ALLOWED: config.get<boolean>('webadmin.configuration.edition.allowed')
232 get EMAIL () { return config.get<string>('admin.email') }
235 get ENABLED () { return config.get<boolean>('contact_form.enabled') }
238 get ENABLED () { return config.get<boolean>('signup.enabled') },
239 get LIMIT () { return config.get<number>('signup.limit') },
240 get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
241 get MINIMUM_AGE () { return config.get<number>('signup.minimum_age') },
244 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
245 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
250 get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
251 get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
254 get MAX_PER_USER () { return config.get<number>('video_channels.max_per_user') }
257 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
258 get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
259 get ALLOW_AUDIO_FILES () { return config.get<boolean>('transcoding.allow_audio_files') },
260 get THREADS () { return config.get<number>('transcoding.threads') },
261 get CONCURRENCY () { return config.get<number>('transcoding.concurrency') },
262 get PROFILE () { return config.get<string>('transcoding.profile') },
264 get '0p' () { return config.get<boolean>('transcoding.resolutions.0p') },
265 get '144p' () { return config.get<boolean>('transcoding.resolutions.144p') },
266 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
267 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
268 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
269 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
270 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') },
271 get '1440p' () { return config.get<boolean>('transcoding.resolutions.1440p') },
272 get '2160p' () { return config.get<boolean>('transcoding.resolutions.2160p') }
275 get ENABLED () { return config.get<boolean>('transcoding.hls.enabled') }
278 get ENABLED () { return config.get<boolean>('transcoding.webtorrent.enabled') }
282 get ENABLED () { return config.get<boolean>('live.enabled') },
284 get MAX_DURATION () { return parseDurationToMs(config.get<string>('live.max_duration')) },
285 get MAX_INSTANCE_LIVES () { return config.get<number>('live.max_instance_lives') },
286 get MAX_USER_LIVES () { return config.get<number>('live.max_user_lives') },
288 get ALLOW_REPLAY () { return config.get<boolean>('live.allow_replay') },
291 get ENABLED () { return config.get<boolean>('live.rtmp.enabled') },
292 get PORT () { return config.get<number>('live.rtmp.port') }
296 get ENABLED () { return config.get<boolean>('live.rtmps.enabled') },
297 get PORT () { return config.get<number>('live.rtmps.port') },
298 get KEY_FILE () { return config.get<string>('live.rtmps.key_file') },
299 get CERT_FILE () { return config.get<string>('live.rtmps.cert_file') }
303 get ENABLED () { return config.get<boolean>('live.transcoding.enabled') },
304 get THREADS () { return config.get<number>('live.transcoding.threads') },
305 get PROFILE () { return config.get<string>('live.transcoding.profile') },
308 get '144p' () { return config.get<boolean>('live.transcoding.resolutions.144p') },
309 get '240p' () { return config.get<boolean>('live.transcoding.resolutions.240p') },
310 get '360p' () { return config.get<boolean>('live.transcoding.resolutions.360p') },
311 get '480p' () { return config.get<boolean>('live.transcoding.resolutions.480p') },
312 get '720p' () { return config.get<boolean>('live.transcoding.resolutions.720p') },
313 get '1080p' () { return config.get<boolean>('live.transcoding.resolutions.1080p') },
314 get '1440p' () { return config.get<boolean>('live.transcoding.resolutions.1440p') },
315 get '2160p' () { return config.get<boolean>('live.transcoding.resolutions.2160p') }
321 get CONCURRENCY () { return config.get<number>('import.videos.concurrency') },
324 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') },
326 YOUTUBE_DL_RELEASE: {
327 get URL () { return config.get<string>('import.videos.http.youtube_dl_release.url') },
328 get NAME () { return config.get<string>('import.videos.http.youtube_dl_release.name') }
331 get FORCE_IPV4 () { return config.get<boolean>('import.videos.http.force_ipv4') }
334 get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
341 get ENABLED () { return config.get<boolean>('auto_blacklist.videos.of_users.enabled') }
347 get SIZE () { return config.get<number>('cache.previews.size') }
350 get SIZE () { return config.get<number>('cache.captions.size') }
353 get SIZE () { return config.get<number>('cache.torrents.size') }
357 get NAME () { return config.get<string>('instance.name') },
358 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
359 get DESCRIPTION () { return config.get<string>('instance.description') },
360 get TERMS () { return config.get<string>('instance.terms') },
361 get CODE_OF_CONDUCT () { return config.get<string>('instance.code_of_conduct') },
363 get CREATION_REASON () { return config.get<string>('instance.creation_reason') },
365 get MODERATION_INFORMATION () { return config.get<string>('instance.moderation_information') },
366 get ADMINISTRATOR () { return config.get<string>('instance.administrator') },
367 get MAINTENANCE_LIFETIME () { return config.get<string>('instance.maintenance_lifetime') },
368 get BUSINESS_MODEL () { return config.get<string>('instance.business_model') },
369 get HARDWARE_INFORMATION () { return config.get<string>('instance.hardware_information') },
371 get LANGUAGES () { return config.get<string[]>('instance.languages') || [] },
372 get CATEGORIES () { return config.get<number[]>('instance.categories') || [] },
374 get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
375 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
377 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
380 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
381 get CSS () { return config.get<string>('instance.customizations.css') }
383 get ROBOTS () { return config.get<string>('instance.robots') },
384 get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
385 get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
389 get USERNAME () { return config.get<string>('services.twitter.username') },
390 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
395 get ENABLED () { return config.get<boolean>('followers.instance.enabled') },
396 get MANUAL_APPROVAL () { return config.get<boolean>('followers.instance.manual_approval') }
403 return config.get<boolean>('followings.instance.auto_follow_back.enabled')
408 return config.get<boolean>('followings.instance.auto_follow_index.enabled')
411 return config.get<string>('followings.instance.auto_follow_index.index_url')
417 get DEFAULT () { return config.get<string>('theme.default') }
420 get ENABLED () { return config.get<boolean>('broadcast_message.enabled') },
421 get MESSAGE () { return config.get<string>('broadcast_message.message') },
422 get LEVEL () { return config.get<BroadcastMessageLevel>('broadcast_message.level') },
423 get DISMISSABLE () { return config.get<boolean>('broadcast_message.dismissable') }
427 get USERS () { return config.get<boolean>('search.remote_uri.users') },
428 get ANONYMOUS () { return config.get<boolean>('search.remote_uri.anonymous') }
431 get ENABLED () { return config.get<boolean>('search.search_index.enabled') },
432 get URL () { return config.get<string>('search.search_index.url') },
433 get DISABLE_LOCAL_SEARCH () { return config.get<boolean>('search.search_index.disable_local_search') },
434 get IS_DEFAULT_SEARCH () { return config.get<boolean>('search.search_index.is_default_search') }
439 function registerConfigChangedHandler (fun: Function) {
440 configChangedHandlers.push(fun)
443 function isEmailEnabled () {
444 if (CONFIG.SMTP.TRANSPORT === 'sendmail' && CONFIG.SMTP.SENDMAIL) return true
446 if (CONFIG.SMTP.TRANSPORT === 'smtp' && CONFIG.SMTP.HOSTNAME && CONFIG.SMTP.PORT) return true
451 // ---------------------------------------------------------------------------
455 registerConfigChangedHandler,
459 // ---------------------------------------------------------------------------
461 function getLocalConfigFilePath () {
462 const localConfigDir = getLocalConfigDir()
464 let filename = 'local'
465 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
466 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
468 return join(localConfigDir, filename + '.json')
471 function getLocalConfigDir () {
472 if (process.env.PEERTUBE_LOCAL_CONFIG) return process.env.PEERTUBE_LOCAL_CONFIG
474 const configSources = config.util.getConfigSources()
475 if (configSources.length === 0) throw new Error('Invalid config source.')
477 return dirname(configSources[0].name)
480 function buildVideosRedundancy (objs: any[]): VideosRedundancyStrategy[] {
483 if (!Array.isArray(objs)) return objs
485 return objs.map(obj => {
486 return Object.assign({}, obj, {
487 minLifetime: parseDurationToMs(obj.min_lifetime),
488 size: bytes.parse(obj.size),
489 minViews: obj.min_views
494 export function reloadConfig () {
496 function getConfigDirectories () {
497 if (process.env.NODE_CONFIG_DIR) {
498 return process.env.NODE_CONFIG_DIR.split(':')
501 return [ join(root(), 'config') ]
505 const directories = getConfigDirectories()
507 for (const fileName in require.cache) {
508 if (directories.some((dir) => fileName.includes(dir)) === false) {
512 delete require.cache[fileName]
515 decacheModule('config')
520 config = require('config')
522 for (const configChangedHandler of configChangedHandlers) {
523 configChangedHandler()