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 { buildPath, root } from '../../shared/core-utils'
8 import { VideoPrivacy, VideosRedundancyStrategy } from '../../shared/models'
9 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
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 PEERTUBE: config.get<string>('secrets.peertube')
27 DBNAME: config.has('database.name') ? config.get<string>('database.name') : 'peertube' + config.get<string>('database.suffix'),
28 HOSTNAME: config.get<string>('database.hostname'),
29 PORT: config.get<number>('database.port'),
30 SSL: config.get<boolean>('database.ssl'),
31 USERNAME: config.get<string>('database.username'),
32 PASSWORD: config.get<string>('database.password'),
34 MAX: config.get<number>('database.pool.max')
38 HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
39 PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
40 SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
41 AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
42 DB: config.has('redis.db') ? config.get<number>('redis.db') : null
45 TRANSPORT: config.has('smtp.transport') ? config.get<string>('smtp.transport') : 'smtp',
46 SENDMAIL: config.has('smtp.sendmail') ? config.get<string>('smtp.sendmail') : null,
47 HOSTNAME: config.get<string>('smtp.hostname'),
48 PORT: config.get<number>('smtp.port'),
49 USERNAME: config.get<string>('smtp.username'),
50 PASSWORD: config.get<string>('smtp.password'),
51 TLS: config.get<boolean>('smtp.tls'),
52 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
53 CA_FILE: config.get<string>('smtp.ca_file'),
54 FROM_ADDRESS: config.get<string>('smtp.from_address')
58 SIGNATURE: config.get<string>('email.body.signature')
61 PREFIX: config.get<string>('email.subject.prefix') + ' '
68 get PREFER_AUTHOR_DISPLAY_NAME () { return config.get<boolean>('client.videos.miniature.prefer_author_display_name') },
69 get DISPLAY_AUTHOR_AVATAR () { return config.get<boolean>('client.videos.miniature.display_author_avatar') }
72 get MAX_CHUNK_SIZE () { return parseBytes(config.get<number>('client.videos.resumable_upload.max_chunk_size') || 0) }
77 get REDIRECT_ON_SINGLE_EXTERNAL_AUTH () { return config.get<boolean>('client.menu.login.redirect_on_single_external_auth') }
84 DOWNLOAD_ENABLED: config.get<boolean>('defaults.publish.download_enabled'),
85 COMMENTS_ENABLED: config.get<boolean>('defaults.publish.comments_enabled'),
86 PRIVACY: config.get<VideoPrivacy>('defaults.publish.privacy'),
87 LICENCE: config.get<number>('defaults.publish.licence')
91 ENABLED: config.get<boolean>('defaults.p2p.webapp.enabled')
94 ENABLED: config.get<boolean>('defaults.p2p.embed.enabled')
100 TMP_DIR: buildPath(config.get<string>('storage.tmp')),
101 BIN_DIR: buildPath(config.get<string>('storage.bin')),
102 ACTOR_IMAGES: buildPath(config.get<string>('storage.avatars')),
103 LOG_DIR: buildPath(config.get<string>('storage.logs')),
104 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
105 STREAMING_PLAYLISTS_DIR: buildPath(config.get<string>('storage.streaming_playlists')),
106 REDUNDANCY_DIR: buildPath(config.get<string>('storage.redundancy')),
107 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
108 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
109 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
110 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
111 CACHE_DIR: buildPath(config.get<string>('storage.cache')),
112 PLUGINS_DIR: buildPath(config.get<string>('storage.plugins')),
113 CLIENT_OVERRIDES_DIR: buildPath(config.get<string>('storage.client_overrides')),
114 WELL_KNOWN_DIR: buildPath(config.get<string>('storage.well_known'))
117 PRIVATE_FILES_REQUIRE_AUTH: config.get<boolean>('static_files.private_files_require_auth')
120 ENABLED: config.get<boolean>('object_storage.enabled'),
121 MAX_UPLOAD_PART: bytes.parse(config.get<string>('object_storage.max_upload_part')),
122 ENDPOINT: config.get<string>('object_storage.endpoint'),
123 REGION: config.get<string>('object_storage.region'),
125 PUBLIC: config.get<string>('object_storage.upload_acl.public'),
126 PRIVATE: config.get<string>('object_storage.upload_acl.private')
129 ACCESS_KEY_ID: config.get<string>('object_storage.credentials.access_key_id'),
130 SECRET_ACCESS_KEY: config.get<string>('object_storage.credentials.secret_access_key')
133 PROXIFY_PRIVATE_FILES: config.get<boolean>('object_storage.proxy.proxify_private_files')
136 BUCKET_NAME: config.get<string>('object_storage.videos.bucket_name'),
137 PREFIX: config.get<string>('object_storage.videos.prefix'),
138 BASE_URL: config.get<string>('object_storage.videos.base_url')
140 STREAMING_PLAYLISTS: {
141 BUCKET_NAME: config.get<string>('object_storage.streaming_playlists.bucket_name'),
142 PREFIX: config.get<string>('object_storage.streaming_playlists.prefix'),
143 BASE_URL: config.get<string>('object_storage.streaming_playlists.base_url')
147 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
148 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
149 HOSTNAME: config.get<string>('webserver.hostname'),
150 PORT: config.get<number>('webserver.port')
154 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.api.window')),
155 MAX: config.get<number>('rates_limit.api.max')
158 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.signup.window')),
159 MAX: config.get<number>('rates_limit.signup.max')
162 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.login.window')),
163 MAX: config.get<number>('rates_limit.login.max')
165 RECEIVE_CLIENT_LOG: {
166 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.receive_client_log.window')),
167 MAX: config.get<number>('rates_limit.receive_client_log.max')
170 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.ask_send_email.window')),
171 MAX: config.get<number>('rates_limit.ask_send_email.max')
174 TRUST_PROXY: config.get<string[]>('trust_proxy'),
176 LEVEL: config.get<string>('log.level'),
178 ENABLED: config.get<boolean>('log.rotation.enabled'),
179 MAX_FILE_SIZE: bytes.parse(config.get<string>('log.rotation.max_file_size')),
180 MAX_FILES: config.get<number>('log.rotation.max_files')
182 ANONYMIZE_IP: config.get<boolean>('log.anonymize_ip'),
183 LOG_PING_REQUESTS: config.get<boolean>('log.log_ping_requests'),
184 LOG_TRACKER_UNKNOWN_INFOHASH: config.get<boolean>('log.log_tracker_unknown_infohash'),
185 PRETTIFY_SQL: config.get<boolean>('log.prettify_sql'),
186 ACCEPT_CLIENT_LOG: config.get<boolean>('log.accept_client_log')
190 ENABLED: config.get<boolean>('open_telemetry.metrics.enabled'),
192 PROMETHEUS_EXPORTER: {
193 HOSTNAME: config.get<string>('open_telemetry.metrics.prometheus_exporter.hostname'),
194 PORT: config.get<number>('open_telemetry.metrics.prometheus_exporter.port')
198 ENABLED: config.get<boolean>('open_telemetry.tracing.enabled'),
201 ENDPOINT: config.get<string>('open_telemetry.tracing.jaeger_exporter.endpoint')
207 INTERVAL_DAYS: config.get<number>('trending.videos.interval_days'),
209 get ENABLED () { return config.get<string[]>('trending.videos.algorithms.enabled') },
210 get DEFAULT () { return config.get<string>('trending.videos.algorithms.default') }
216 CHECK_INTERVAL: parseDurationToMs(config.get<string>('redundancy.videos.check_interval')),
217 STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
222 ACCEPT_FROM: config.get<VideoRedundancyConfigFilter>('remote_redundancy.videos.accept_from')
226 ENABLED: config.get<boolean>('csp.enabled'),
227 REPORT_ONLY: config.get<boolean>('csp.report_only'),
228 REPORT_URI: config.get<string>('csp.report_uri')
232 ENABLED: config.get<boolean>('security.frameguard.enabled')
236 ENABLED: config.get<boolean>('tracker.enabled'),
237 PRIVATE: config.get<boolean>('tracker.private'),
238 REJECT_TOO_MANY_ANNOUNCES: config.get<boolean>('tracker.reject_too_many_announces')
242 MAX_AGE: parseDurationToMs(config.get('history.videos.max_age'))
248 MAX_AGE: parseDurationToMs(config.get('views.videos.remote.max_age'))
250 LOCAL_BUFFER_UPDATE_INTERVAL: parseDurationToMs(config.get('views.videos.local_buffer_update_interval')),
251 IP_VIEW_EXPIRATION: parseDurationToMs(config.get('views.videos.ip_view_expiration'))
255 ENABLED: config.get<boolean>('geo_ip.enabled'),
257 DATABASE_URL: config.get<string>('geo_ip.country.database_url')
262 ENABLED: config.get<boolean>('plugins.index.enabled'),
263 CHECK_LATEST_VERSIONS_INTERVAL: parseDurationToMs(config.get<string>('plugins.index.check_latest_versions_interval')),
264 URL: config.get<string>('plugins.index.url')
269 FEDERATE_UNLISTED: config.get<boolean>('federation.videos.federate_unlisted'),
270 CLEANUP_REMOTE_INTERACTIONS: config.get<boolean>('federation.videos.cleanup_remote_interactions')
274 CHECK_LATEST_VERSION: {
275 ENABLED: config.get<boolean>('peertube.check_latest_version.enabled'),
276 URL: config.get<string>('peertube.check_latest_version.url')
282 ALLOWED: config.get<boolean>('webadmin.configuration.edition.allowed')
288 COUNT: config.get<number>('feeds.videos.count')
291 COUNT: config.get<number>('feeds.comments.count')
295 get EMAIL () { return config.get<string>('admin.email') }
298 get ENABLED () { return config.get<boolean>('contact_form.enabled') }
301 get ENABLED () { return config.get<boolean>('signup.enabled') },
302 get LIMIT () { return config.get<number>('signup.limit') },
303 get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
304 get MINIMUM_AGE () { return config.get<number>('signup.minimum_age') },
307 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
308 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
313 get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
314 get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
317 get MAX_PER_USER () { return config.get<number>('video_channels.max_per_user') }
320 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
321 get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
322 get ALLOW_AUDIO_FILES () { return config.get<boolean>('transcoding.allow_audio_files') },
323 get THREADS () { return config.get<number>('transcoding.threads') },
324 get CONCURRENCY () { return config.get<number>('transcoding.concurrency') },
325 get PROFILE () { return config.get<string>('transcoding.profile') },
326 get ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION () { return config.get<boolean>('transcoding.always_transcode_original_resolution') },
328 get '0p' () { return config.get<boolean>('transcoding.resolutions.0p') },
329 get '144p' () { return config.get<boolean>('transcoding.resolutions.144p') },
330 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
331 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
332 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
333 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
334 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') },
335 get '1440p' () { return config.get<boolean>('transcoding.resolutions.1440p') },
336 get '2160p' () { return config.get<boolean>('transcoding.resolutions.2160p') }
339 get ENABLED () { return config.get<boolean>('transcoding.hls.enabled') }
342 get ENABLED () { return config.get<boolean>('transcoding.webtorrent.enabled') }
346 get ENABLED () { return config.get<boolean>('live.enabled') },
348 get MAX_DURATION () { return parseDurationToMs(config.get<string>('live.max_duration')) },
349 get MAX_INSTANCE_LIVES () { return config.get<number>('live.max_instance_lives') },
350 get MAX_USER_LIVES () { return config.get<number>('live.max_user_lives') },
352 get ALLOW_REPLAY () { return config.get<boolean>('live.allow_replay') },
355 get ENABLED () { return config.get<boolean>('live.latency_setting.enabled') }
359 get ENABLED () { return config.get<boolean>('live.rtmp.enabled') },
360 get PORT () { return config.get<number>('live.rtmp.port') },
361 get HOSTNAME () { return config.get<number>('live.rtmp.hostname') },
362 get PUBLIC_HOSTNAME () { return config.get<number>('live.rtmp.public_hostname') }
366 get ENABLED () { return config.get<boolean>('live.rtmps.enabled') },
367 get PORT () { return config.get<number>('live.rtmps.port') },
368 get HOSTNAME () { return config.get<number>('live.rtmps.hostname') },
369 get PUBLIC_HOSTNAME () { return config.get<number>('live.rtmps.public_hostname') },
370 get KEY_FILE () { return config.get<string>('live.rtmps.key_file') },
371 get CERT_FILE () { return config.get<string>('live.rtmps.cert_file') }
375 get ENABLED () { return config.get<boolean>('live.transcoding.enabled') },
376 get THREADS () { return config.get<number>('live.transcoding.threads') },
377 get PROFILE () { return config.get<string>('live.transcoding.profile') },
379 get ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION () { return config.get<boolean>('live.transcoding.always_transcode_original_resolution') },
382 get '144p' () { return config.get<boolean>('live.transcoding.resolutions.144p') },
383 get '240p' () { return config.get<boolean>('live.transcoding.resolutions.240p') },
384 get '360p' () { return config.get<boolean>('live.transcoding.resolutions.360p') },
385 get '480p' () { return config.get<boolean>('live.transcoding.resolutions.480p') },
386 get '720p' () { return config.get<boolean>('live.transcoding.resolutions.720p') },
387 get '1080p' () { return config.get<boolean>('live.transcoding.resolutions.1080p') },
388 get '1440p' () { return config.get<boolean>('live.transcoding.resolutions.1440p') },
389 get '2160p' () { return config.get<boolean>('live.transcoding.resolutions.2160p') }
394 get ENABLED () { return config.get<boolean>('video_studio.enabled') }
398 get CONCURRENCY () { return config.get<number>('import.videos.concurrency') },
399 get TIMEOUT () { return parseDurationToMs(config.get<string>('import.videos.timeout')) },
402 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') },
404 YOUTUBE_DL_RELEASE: {
405 get URL () { return config.get<string>('import.videos.http.youtube_dl_release.url') },
406 get NAME () { return config.get<string>('import.videos.http.youtube_dl_release.name') },
407 get PYTHON_PATH () { return config.get<string>('import.videos.http.youtube_dl_release.python_path') }
410 get FORCE_IPV4 () { return config.get<boolean>('import.videos.http.force_ipv4') }
413 get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
416 VIDEO_CHANNEL_SYNCHRONIZATION: {
417 get ENABLED () { return config.get<boolean>('import.video_channel_synchronization.enabled') },
418 get MAX_PER_USER () { return config.get<number>('import.video_channel_synchronization.max_per_user') },
419 get CHECK_INTERVAL () { return parseDurationToMs(config.get<string>('import.video_channel_synchronization.check_interval')) },
420 get VIDEOS_LIMIT_PER_SYNCHRONIZATION () {
421 return config.get<number>('import.video_channel_synchronization.videos_limit_per_synchronization')
423 get FULL_SYNC_VIDEOS_LIMIT () {
424 return config.get<number>('import.video_channel_synchronization.full_sync_videos_limit')
431 get ENABLED () { return config.get<boolean>('auto_blacklist.videos.of_users.enabled') }
437 get SIZE () { return config.get<number>('cache.previews.size') }
440 get SIZE () { return config.get<number>('cache.captions.size') }
443 get SIZE () { return config.get<number>('cache.torrents.size') }
447 get NAME () { return config.get<string>('instance.name') },
448 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
449 get DESCRIPTION () { return config.get<string>('instance.description') },
450 get TERMS () { return config.get<string>('instance.terms') },
451 get CODE_OF_CONDUCT () { return config.get<string>('instance.code_of_conduct') },
453 get CREATION_REASON () { return config.get<string>('instance.creation_reason') },
455 get MODERATION_INFORMATION () { return config.get<string>('instance.moderation_information') },
456 get ADMINISTRATOR () { return config.get<string>('instance.administrator') },
457 get MAINTENANCE_LIFETIME () { return config.get<string>('instance.maintenance_lifetime') },
458 get BUSINESS_MODEL () { return config.get<string>('instance.business_model') },
459 get HARDWARE_INFORMATION () { return config.get<string>('instance.hardware_information') },
461 get LANGUAGES () { return config.get<string[]>('instance.languages') || [] },
462 get CATEGORIES () { return config.get<number[]>('instance.categories') || [] },
464 get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
465 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
467 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
470 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
471 get CSS () { return config.get<string>('instance.customizations.css') }
473 get ROBOTS () { return config.get<string>('instance.robots') },
474 get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
475 get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
479 get USERNAME () { return config.get<string>('services.twitter.username') },
480 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
485 get ENABLED () { return config.get<boolean>('followers.instance.enabled') },
486 get MANUAL_APPROVAL () { return config.get<boolean>('followers.instance.manual_approval') }
493 return config.get<boolean>('followings.instance.auto_follow_back.enabled')
498 return config.get<boolean>('followings.instance.auto_follow_index.enabled')
501 return config.get<string>('followings.instance.auto_follow_index.index_url')
507 get DEFAULT () { return config.get<string>('theme.default') }
510 get ENABLED () { return config.get<boolean>('broadcast_message.enabled') },
511 get MESSAGE () { return config.get<string>('broadcast_message.message') },
512 get LEVEL () { return config.get<BroadcastMessageLevel>('broadcast_message.level') },
513 get DISMISSABLE () { return config.get<boolean>('broadcast_message.dismissable') }
517 get USERS () { return config.get<boolean>('search.remote_uri.users') },
518 get ANONYMOUS () { return config.get<boolean>('search.remote_uri.anonymous') }
521 get ENABLED () { return config.get<boolean>('search.search_index.enabled') },
522 get URL () { return config.get<string>('search.search_index.url') },
523 get DISABLE_LOCAL_SEARCH () { return config.get<boolean>('search.search_index.disable_local_search') },
524 get IS_DEFAULT_SEARCH () { return config.get<boolean>('search.search_index.is_default_search') }
530 function registerConfigChangedHandler (fun: Function) {
531 configChangedHandlers.push(fun)
534 function isEmailEnabled () {
535 if (CONFIG.SMTP.TRANSPORT === 'sendmail' && CONFIG.SMTP.SENDMAIL) return true
537 if (CONFIG.SMTP.TRANSPORT === 'smtp' && CONFIG.SMTP.HOSTNAME && CONFIG.SMTP.PORT) return true
542 // ---------------------------------------------------------------------------
546 registerConfigChangedHandler,
550 // ---------------------------------------------------------------------------
552 function getLocalConfigFilePath () {
553 const localConfigDir = getLocalConfigDir()
555 let filename = 'local'
556 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
557 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
559 return join(localConfigDir, filename + '.json')
562 function getLocalConfigDir () {
563 if (process.env.PEERTUBE_LOCAL_CONFIG) return process.env.PEERTUBE_LOCAL_CONFIG
565 const configSources = config.util.getConfigSources()
566 if (configSources.length === 0) throw new Error('Invalid config source.')
568 return dirname(configSources[0].name)
571 function buildVideosRedundancy (objs: any[]): VideosRedundancyStrategy[] {
574 if (!Array.isArray(objs)) return objs
576 return objs.map(obj => {
577 return Object.assign({}, obj, {
578 minLifetime: parseDurationToMs(obj.min_lifetime),
579 size: bytes.parse(obj.size),
580 minViews: obj.min_views
585 export function reloadConfig () {
587 function getConfigDirectories () {
588 if (process.env.NODE_CONFIG_DIR) {
589 return process.env.NODE_CONFIG_DIR.split(':')
592 return [ join(root(), 'config') ]
596 const directories = getConfigDirectories()
598 for (const fileName in require.cache) {
599 if (directories.some((dir) => fileName.includes(dir)) === false) {
603 delete require.cache[fileName]
606 decacheModule('config')
611 config = require('config')
613 for (const configChangedHandler of configChangedHandlers) {
614 configChangedHandler()