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 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') },
66 get DISPLAY_AUTHOR_AVATAR () { return config.get<boolean>('client.videos.miniature.display_author_avatar') }
69 get MAX_CHUNK_SIZE () { return parseBytes(config.get<number>('client.videos.resumable_upload.max_chunk_size') || 0) }
74 get REDIRECT_ON_SINGLE_EXTERNAL_AUTH () { return config.get<boolean>('client.menu.login.redirect_on_single_external_auth') }
81 DOWNLOAD_ENABLED: config.get<boolean>('defaults.publish.download_enabled'),
82 COMMENTS_ENABLED: config.get<boolean>('defaults.publish.comments_enabled'),
83 PRIVACY: config.get<VideoPrivacy>('defaults.publish.privacy'),
84 LICENCE: config.get<number>('defaults.publish.licence')
88 ENABLED: config.get<boolean>('defaults.p2p.webapp.enabled')
91 ENABLED: config.get<boolean>('defaults.p2p.embed.enabled')
97 TMP_DIR: buildPath(config.get<string>('storage.tmp')),
98 BIN_DIR: buildPath(config.get<string>('storage.bin')),
99 ACTOR_IMAGES: buildPath(config.get<string>('storage.avatars')),
100 LOG_DIR: buildPath(config.get<string>('storage.logs')),
101 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
102 STREAMING_PLAYLISTS_DIR: buildPath(config.get<string>('storage.streaming_playlists')),
103 REDUNDANCY_DIR: buildPath(config.get<string>('storage.redundancy')),
104 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
105 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
106 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
107 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
108 CACHE_DIR: buildPath(config.get<string>('storage.cache')),
109 PLUGINS_DIR: buildPath(config.get<string>('storage.plugins')),
110 CLIENT_OVERRIDES_DIR: buildPath(config.get<string>('storage.client_overrides')),
111 WELL_KNOWN_DIR: buildPath(config.get<string>('storage.well_known'))
114 ENABLED: config.get<boolean>('object_storage.enabled'),
115 MAX_UPLOAD_PART: bytes.parse(config.get<string>('object_storage.max_upload_part')),
116 ENDPOINT: config.get<string>('object_storage.endpoint'),
117 REGION: config.get<string>('object_storage.region'),
118 UPLOAD_ACL: config.get<string>('object_storage.upload_acl'),
120 ACCESS_KEY_ID: config.get<string>('object_storage.credentials.access_key_id'),
121 SECRET_ACCESS_KEY: config.get<string>('object_storage.credentials.secret_access_key')
124 BUCKET_NAME: config.get<string>('object_storage.videos.bucket_name'),
125 PREFIX: config.get<string>('object_storage.videos.prefix'),
126 BASE_URL: config.get<string>('object_storage.videos.base_url')
128 STREAMING_PLAYLISTS: {
129 BUCKET_NAME: config.get<string>('object_storage.streaming_playlists.bucket_name'),
130 PREFIX: config.get<string>('object_storage.streaming_playlists.prefix'),
131 BASE_URL: config.get<string>('object_storage.streaming_playlists.base_url')
135 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
136 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
137 HOSTNAME: config.get<string>('webserver.hostname'),
138 PORT: config.get<number>('webserver.port')
142 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.api.window')),
143 MAX: config.get<number>('rates_limit.api.max')
146 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.signup.window')),
147 MAX: config.get<number>('rates_limit.signup.max')
150 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.login.window')),
151 MAX: config.get<number>('rates_limit.login.max')
153 RECEIVE_CLIENT_LOG: {
154 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.receive_client_log.window')),
155 MAX: config.get<number>('rates_limit.receive_client_log.max')
158 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.ask_send_email.window')),
159 MAX: config.get<number>('rates_limit.ask_send_email.max')
162 TRUST_PROXY: config.get<string[]>('trust_proxy'),
164 LEVEL: config.get<string>('log.level'),
166 ENABLED: config.get<boolean>('log.rotation.enabled'),
167 MAX_FILE_SIZE: bytes.parse(config.get<string>('log.rotation.max_file_size')),
168 MAX_FILES: config.get<number>('log.rotation.max_files')
170 ANONYMIZE_IP: config.get<boolean>('log.anonymize_ip'),
171 LOG_PING_REQUESTS: config.get<boolean>('log.log_ping_requests'),
172 LOG_TRACKER_UNKNOWN_INFOHASH: config.get<boolean>('log.log_tracker_unknown_infohash'),
173 PRETTIFY_SQL: config.get<boolean>('log.prettify_sql'),
174 ACCEPT_CLIENT_LOG: config.get<boolean>('log.accept_client_log')
178 ENABLED: config.get<boolean>('open_telemetry.metrics.enabled'),
180 PROMETHEUS_EXPORTER: {
181 PORT: config.get<number>('open_telemetry.metrics.prometheus_exporter.port')
185 ENABLED: config.get<boolean>('open_telemetry.tracing.enabled'),
188 ENDPOINT: config.get<string>('open_telemetry.tracing.jaeger_exporter.endpoint')
194 INTERVAL_DAYS: config.get<number>('trending.videos.interval_days'),
196 get ENABLED () { return config.get<string[]>('trending.videos.algorithms.enabled') },
197 get DEFAULT () { return config.get<string>('trending.videos.algorithms.default') }
203 CHECK_INTERVAL: parseDurationToMs(config.get<string>('redundancy.videos.check_interval')),
204 STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
209 ACCEPT_FROM: config.get<VideoRedundancyConfigFilter>('remote_redundancy.videos.accept_from')
213 ENABLED: config.get<boolean>('csp.enabled'),
214 REPORT_ONLY: config.get<boolean>('csp.report_only'),
215 REPORT_URI: config.get<string>('csp.report_uri')
219 ENABLED: config.get<boolean>('security.frameguard.enabled')
223 ENABLED: config.get<boolean>('tracker.enabled'),
224 PRIVATE: config.get<boolean>('tracker.private'),
225 REJECT_TOO_MANY_ANNOUNCES: config.get<boolean>('tracker.reject_too_many_announces')
229 MAX_AGE: parseDurationToMs(config.get('history.videos.max_age'))
235 MAX_AGE: parseDurationToMs(config.get('views.videos.remote.max_age'))
237 LOCAL_BUFFER_UPDATE_INTERVAL: parseDurationToMs(config.get('views.videos.local_buffer_update_interval')),
238 IP_VIEW_EXPIRATION: parseDurationToMs(config.get('views.videos.ip_view_expiration'))
242 ENABLED: config.get<boolean>('geo_ip.enabled'),
244 DATABASE_URL: config.get<string>('geo_ip.country.database_url')
249 ENABLED: config.get<boolean>('plugins.index.enabled'),
250 CHECK_LATEST_VERSIONS_INTERVAL: parseDurationToMs(config.get<string>('plugins.index.check_latest_versions_interval')),
251 URL: config.get<string>('plugins.index.url')
256 FEDERATE_UNLISTED: config.get<boolean>('federation.videos.federate_unlisted'),
257 CLEANUP_REMOTE_INTERACTIONS: config.get<boolean>('federation.videos.cleanup_remote_interactions')
261 CHECK_LATEST_VERSION: {
262 ENABLED: config.get<boolean>('peertube.check_latest_version.enabled'),
263 URL: config.get<string>('peertube.check_latest_version.url')
269 ALLOWED: config.get<boolean>('webadmin.configuration.edition.allowed')
275 COUNT: config.get<number>('feeds.videos.count')
278 COUNT: config.get<number>('feeds.comments.count')
282 get EMAIL () { return config.get<string>('admin.email') }
285 get ENABLED () { return config.get<boolean>('contact_form.enabled') }
288 get ENABLED () { return config.get<boolean>('signup.enabled') },
289 get LIMIT () { return config.get<number>('signup.limit') },
290 get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
291 get MINIMUM_AGE () { return config.get<number>('signup.minimum_age') },
294 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
295 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
300 get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
301 get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
304 get MAX_PER_USER () { return config.get<number>('video_channels.max_per_user') }
307 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
308 get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
309 get ALLOW_AUDIO_FILES () { return config.get<boolean>('transcoding.allow_audio_files') },
310 get THREADS () { return config.get<number>('transcoding.threads') },
311 get CONCURRENCY () { return config.get<number>('transcoding.concurrency') },
312 get PROFILE () { return config.get<string>('transcoding.profile') },
313 get ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION () { return config.get<boolean>('transcoding.always_transcode_original_resolution') },
315 get '0p' () { return config.get<boolean>('transcoding.resolutions.0p') },
316 get '144p' () { return config.get<boolean>('transcoding.resolutions.144p') },
317 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
318 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
319 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
320 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
321 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') },
322 get '1440p' () { return config.get<boolean>('transcoding.resolutions.1440p') },
323 get '2160p' () { return config.get<boolean>('transcoding.resolutions.2160p') }
326 get ENABLED () { return config.get<boolean>('transcoding.hls.enabled') }
329 get ENABLED () { return config.get<boolean>('transcoding.webtorrent.enabled') }
333 get ENABLED () { return config.get<boolean>('live.enabled') },
335 get MAX_DURATION () { return parseDurationToMs(config.get<string>('live.max_duration')) },
336 get MAX_INSTANCE_LIVES () { return config.get<number>('live.max_instance_lives') },
337 get MAX_USER_LIVES () { return config.get<number>('live.max_user_lives') },
339 get ALLOW_REPLAY () { return config.get<boolean>('live.allow_replay') },
342 get ENABLED () { return config.get<boolean>('live.latency_setting.enabled') }
346 get ENABLED () { return config.get<boolean>('live.rtmp.enabled') },
347 get PORT () { return config.get<number>('live.rtmp.port') },
348 get HOSTNAME () { return config.get<number>('live.rtmp.hostname') },
349 get PUBLIC_HOSTNAME () { return config.get<number>('live.rtmp.public_hostname') }
353 get ENABLED () { return config.get<boolean>('live.rtmps.enabled') },
354 get PORT () { return config.get<number>('live.rtmps.port') },
355 get HOSTNAME () { return config.get<number>('live.rtmps.hostname') },
356 get PUBLIC_HOSTNAME () { return config.get<number>('live.rtmps.public_hostname') },
357 get KEY_FILE () { return config.get<string>('live.rtmps.key_file') },
358 get CERT_FILE () { return config.get<string>('live.rtmps.cert_file') }
362 get ENABLED () { return config.get<boolean>('live.transcoding.enabled') },
363 get THREADS () { return config.get<number>('live.transcoding.threads') },
364 get PROFILE () { return config.get<string>('live.transcoding.profile') },
366 get ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION () { return config.get<boolean>('live.transcoding.always_transcode_original_resolution') },
369 get '144p' () { return config.get<boolean>('live.transcoding.resolutions.144p') },
370 get '240p' () { return config.get<boolean>('live.transcoding.resolutions.240p') },
371 get '360p' () { return config.get<boolean>('live.transcoding.resolutions.360p') },
372 get '480p' () { return config.get<boolean>('live.transcoding.resolutions.480p') },
373 get '720p' () { return config.get<boolean>('live.transcoding.resolutions.720p') },
374 get '1080p' () { return config.get<boolean>('live.transcoding.resolutions.1080p') },
375 get '1440p' () { return config.get<boolean>('live.transcoding.resolutions.1440p') },
376 get '2160p' () { return config.get<boolean>('live.transcoding.resolutions.2160p') }
381 get ENABLED () { return config.get<boolean>('video_studio.enabled') }
385 get CONCURRENCY () { return config.get<number>('import.videos.concurrency') },
386 get TIMEOUT () { return parseDurationToMs(config.get<string>('import.videos.timeout')) },
389 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') },
391 YOUTUBE_DL_RELEASE: {
392 get URL () { return config.get<string>('import.videos.http.youtube_dl_release.url') },
393 get NAME () { return config.get<string>('import.videos.http.youtube_dl_release.name') },
394 get PYTHON_PATH () { return config.get<string>('import.videos.http.youtube_dl_release.python_path') }
397 get FORCE_IPV4 () { return config.get<boolean>('import.videos.http.force_ipv4') }
400 get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
403 VIDEO_CHANNEL_SYNCHRONIZATION: {
404 get ENABLED () { return config.get<boolean>('import.video_channel_synchronization.enabled') },
405 get MAX_PER_USER () { return config.get<number>('import.video_channel_synchronization.max_per_user') },
406 get CHECK_INTERVAL () { return parseDurationToMs(config.get<string>('import.video_channel_synchronization.check_interval')) },
407 get VIDEOS_LIMIT_PER_SYNCHRONIZATION () {
408 return config.get<number>('import.video_channel_synchronization.videos_limit_per_synchronization')
415 get ENABLED () { return config.get<boolean>('auto_blacklist.videos.of_users.enabled') }
421 get SIZE () { return config.get<number>('cache.previews.size') }
424 get SIZE () { return config.get<number>('cache.captions.size') }
427 get SIZE () { return config.get<number>('cache.torrents.size') }
431 get NAME () { return config.get<string>('instance.name') },
432 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
433 get DESCRIPTION () { return config.get<string>('instance.description') },
434 get TERMS () { return config.get<string>('instance.terms') },
435 get CODE_OF_CONDUCT () { return config.get<string>('instance.code_of_conduct') },
437 get CREATION_REASON () { return config.get<string>('instance.creation_reason') },
439 get MODERATION_INFORMATION () { return config.get<string>('instance.moderation_information') },
440 get ADMINISTRATOR () { return config.get<string>('instance.administrator') },
441 get MAINTENANCE_LIFETIME () { return config.get<string>('instance.maintenance_lifetime') },
442 get BUSINESS_MODEL () { return config.get<string>('instance.business_model') },
443 get HARDWARE_INFORMATION () { return config.get<string>('instance.hardware_information') },
445 get LANGUAGES () { return config.get<string[]>('instance.languages') || [] },
446 get CATEGORIES () { return config.get<number[]>('instance.categories') || [] },
448 get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
449 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
451 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
454 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
455 get CSS () { return config.get<string>('instance.customizations.css') }
457 get ROBOTS () { return config.get<string>('instance.robots') },
458 get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
459 get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
463 get USERNAME () { return config.get<string>('services.twitter.username') },
464 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
469 get ENABLED () { return config.get<boolean>('followers.instance.enabled') },
470 get MANUAL_APPROVAL () { return config.get<boolean>('followers.instance.manual_approval') }
477 return config.get<boolean>('followings.instance.auto_follow_back.enabled')
482 return config.get<boolean>('followings.instance.auto_follow_index.enabled')
485 return config.get<string>('followings.instance.auto_follow_index.index_url')
491 get DEFAULT () { return config.get<string>('theme.default') }
494 get ENABLED () { return config.get<boolean>('broadcast_message.enabled') },
495 get MESSAGE () { return config.get<string>('broadcast_message.message') },
496 get LEVEL () { return config.get<BroadcastMessageLevel>('broadcast_message.level') },
497 get DISMISSABLE () { return config.get<boolean>('broadcast_message.dismissable') }
501 get USERS () { return config.get<boolean>('search.remote_uri.users') },
502 get ANONYMOUS () { return config.get<boolean>('search.remote_uri.anonymous') }
505 get ENABLED () { return config.get<boolean>('search.search_index.enabled') },
506 get URL () { return config.get<string>('search.search_index.url') },
507 get DISABLE_LOCAL_SEARCH () { return config.get<boolean>('search.search_index.disable_local_search') },
508 get IS_DEFAULT_SEARCH () { return config.get<boolean>('search.search_index.is_default_search') }
514 function registerConfigChangedHandler (fun: Function) {
515 configChangedHandlers.push(fun)
518 function isEmailEnabled () {
519 if (CONFIG.SMTP.TRANSPORT === 'sendmail' && CONFIG.SMTP.SENDMAIL) return true
521 if (CONFIG.SMTP.TRANSPORT === 'smtp' && CONFIG.SMTP.HOSTNAME && CONFIG.SMTP.PORT) return true
526 // ---------------------------------------------------------------------------
530 registerConfigChangedHandler,
534 // ---------------------------------------------------------------------------
536 function getLocalConfigFilePath () {
537 const localConfigDir = getLocalConfigDir()
539 let filename = 'local'
540 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
541 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
543 return join(localConfigDir, filename + '.json')
546 function getLocalConfigDir () {
547 if (process.env.PEERTUBE_LOCAL_CONFIG) return process.env.PEERTUBE_LOCAL_CONFIG
549 const configSources = config.util.getConfigSources()
550 if (configSources.length === 0) throw new Error('Invalid config source.')
552 return dirname(configSources[0].name)
555 function buildVideosRedundancy (objs: any[]): VideosRedundancyStrategy[] {
558 if (!Array.isArray(objs)) return objs
560 return objs.map(obj => {
561 return Object.assign({}, obj, {
562 minLifetime: parseDurationToMs(obj.min_lifetime),
563 size: bytes.parse(obj.size),
564 minViews: obj.min_views
569 export function reloadConfig () {
571 function getConfigDirectories () {
572 if (process.env.NODE_CONFIG_DIR) {
573 return process.env.NODE_CONFIG_DIR.split(':')
576 return [ join(root(), 'config') ]
580 const directories = getConfigDirectories()
582 for (const fileName in require.cache) {
583 if (directories.some((dir) => fileName.includes(dir)) === false) {
587 delete require.cache[fileName]
590 decacheModule('config')
595 config = require('config')
597 for (const configChangedHandler of configChangedHandlers) {
598 configChangedHandler()