]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - server/initializers/config.ts
Set channel banner/avatar in creation form
[github/Chocobozzz/PeerTube.git] / server / initializers / config.ts
CommitLineData
6dd9de95
C
1import { IConfig } from 'config'
2import { dirname, join } from 'path'
b764380a 3import { VideosRedundancyStrategy } from '../../shared/models'
6dd9de95 4// Do not use barrels, remain constants as independent as possible
8f0bc73d 5import { buildPath, parseBytes, parseDurationToMs, root } from '../helpers/core-utils'
6dd9de95
C
6import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
7import * as bytes from 'bytes'
8c9e7875 8import { VideoRedundancyConfigFilter } from '@shared/models/redundancy/video-redundancy-config-filter.type'
72c33e71 9import { BroadcastMessageLevel } from '@shared/models/server'
6dd9de95
C
10
11// Use a variable to reload the configuration if we need
12let config: IConfig = require('config')
13
14const configChangedHandlers: Function[] = []
15
16const CONFIG = {
17 CUSTOM_FILE: getLocalConfigFilePath(),
18 LISTEN: {
19 PORT: config.get<number>('listen.port'),
20 HOSTNAME: config.get<string>('listen.hostname')
21 },
22 DATABASE: {
6ee72211 23 DBNAME: config.has('database.name') ? config.get<string>('database.name') : 'peertube' + config.get<string>('database.suffix'),
6dd9de95
C
24 HOSTNAME: config.get<string>('database.hostname'),
25 PORT: config.get<number>('database.port'),
b0ce7c39 26 SSL: config.get<boolean>('database.ssl'),
6dd9de95
C
27 USERNAME: config.get<string>('database.username'),
28 PASSWORD: config.get<string>('database.password'),
29 POOL: {
30 MAX: config.get<number>('database.pool.max')
31 }
32 },
33 REDIS: {
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
39 },
40 SMTP: {
ed3f089c
IB
41 TRANSPORT: config.has('smtp.transport') ? config.get<string>('smtp.transport') : 'smtp',
42 SENDMAIL: config.has('smtp.sendmail') ? config.get<string>('smtp.sendmail') : null,
6dd9de95
C
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')
51 },
b5bfadf0
YB
52 EMAIL: {
53 BODY: {
54 SIGNATURE: config.get<string>('email.body.signature')
55 },
916937d7
C
56 SUBJECT: {
57 PREFIX: config.get<string>('email.subject.prefix') + ' '
b5bfadf0
YB
58 }
59 },
6dd9de95
C
60 STORAGE: {
61 TMP_DIR: buildPath(config.get<string>('storage.tmp')),
f4796856 62 ACTOR_IMAGES: buildPath(config.get<string>('storage.avatars')),
6dd9de95
C
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')),
345da516 71 CACHE_DIR: buildPath(config.get<string>('storage.cache')),
caf2aaf4
K
72 PLUGINS_DIR: buildPath(config.get<string>('storage.plugins')),
73 CLIENT_OVERRIDES_DIR: buildPath(config.get<string>('storage.client_overrides'))
6dd9de95
C
74 },
75 WEBSERVER: {
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')
80 },
c342726a 81 RATES_LIMIT: {
c1340a6a
C
82 API: {
83 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.api.window')),
84 MAX: config.get<number>('rates_limit.api.max')
85 },
86 SIGNUP: {
87 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.signup.window')),
88 MAX: config.get<number>('rates_limit.signup.max')
89 },
c342726a
YB
90 LOGIN: {
91 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.login.window')),
92 MAX: config.get<number>('rates_limit.login.max')
93 },
94 ASK_SEND_EMAIL: {
95 WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.ask_send_email.window')),
96 MAX: config.get<number>('rates_limit.ask_send_email.max')
97 }
98 },
6dd9de95
C
99 TRUST_PROXY: config.get<string[]>('trust_proxy'),
100 LOG: {
fcf4569f 101 LEVEL: config.get<string>('log.level'),
2f6b5e2d
C
102 ROTATION: {
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')
106 },
12c1e38d 107 ANONYMIZE_IP: config.get<boolean>('log.anonymizeIP'),
1e743faa
C
108 LOG_PING_REQUESTS: config.get<boolean>('log.log_ping_requests'),
109 PRETTIFY_SQL: config.get<boolean>('log.prettify_sql')
6dd9de95 110 },
6dd9de95
C
111 TRENDING: {
112 VIDEOS: {
ba5d4a84
RK
113 INTERVAL_DAYS: config.get<number>('trending.videos.interval_days'),
114 ALGORITHMS: {
115 get ENABLED () { return config.get<string[]>('trending.videos.algorithms.enabled') },
116 get DEFAULT () { return config.get<string>('trending.videos.algorithms.default') }
117 }
6dd9de95
C
118 }
119 },
120 REDUNDANCY: {
121 VIDEOS: {
8f0bc73d 122 CHECK_INTERVAL: parseDurationToMs(config.get<string>('redundancy.videos.check_interval')),
6dd9de95
C
123 STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
124 }
125 },
8c9e7875
C
126 REMOTE_REDUNDANCY: {
127 VIDEOS: {
128 ACCEPT_FROM: config.get<VideoRedundancyConfigFilter>('remote_redundancy.videos.accept_from')
129 }
130 },
6dd9de95
C
131 CSP: {
132 ENABLED: config.get<boolean>('csp.enabled'),
133 REPORT_ONLY: config.get<boolean>('csp.report_only'),
50fcdebd 134 REPORT_URI: config.get<string>('csp.report_uri')
6dd9de95
C
135 },
136 TRACKER: {
137 ENABLED: config.get<boolean>('tracker.enabled'),
138 PRIVATE: config.get<boolean>('tracker.private'),
139 REJECT_TOO_MANY_ANNOUNCES: config.get<boolean>('tracker.reject_too_many_announces')
140 },
8f0bc73d
C
141 HISTORY: {
142 VIDEOS: {
143 MAX_AGE: parseDurationToMs(config.get('history.videos.max_age'))
144 }
145 },
cda03765
C
146 VIEWS: {
147 VIDEOS: {
148 REMOTE: {
149 MAX_AGE: parseDurationToMs(config.get('views.videos.remote.max_age'))
150 }
151 }
152 },
6702a1b2
C
153 PLUGINS: {
154 INDEX: {
155 ENABLED: config.get<boolean>('plugins.index.enabled'),
d133f385
C
156 CHECK_LATEST_VERSIONS_INTERVAL: parseDurationToMs(config.get<string>('plugins.index.check_latest_versions_interval')),
157 URL: config.get<string>('plugins.index.url')
6702a1b2
C
158 }
159 },
3092e9bb
LB
160 FEDERATION: {
161 VIDEOS: {
74d249bc
C
162 FEDERATE_UNLISTED: config.get<boolean>('federation.videos.federate_unlisted'),
163 CLEANUP_REMOTE_INTERACTIONS: config.get<boolean>('federation.videos.cleanup_remote_interactions')
3092e9bb
LB
164 }
165 },
32a18cbf
C
166 PEERTUBE: {
167 CHECK_LATEST_VERSION: {
168 ENABLED: config.get<boolean>('peertube.check_latest_version.enabled'),
169 URL: config.get<string>('peertube.check_latest_version.url')
170 }
171 },
6dd9de95
C
172 ADMIN: {
173 get EMAIL () { return config.get<string>('admin.email') }
174 },
175 CONTACT_FORM: {
176 get ENABLED () { return config.get<boolean>('contact_form.enabled') }
177 },
178 SIGNUP: {
179 get ENABLED () { return config.get<boolean>('signup.enabled') },
180 get LIMIT () { return config.get<number>('signup.limit') },
181 get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
182 FILTERS: {
183 CIDR: {
184 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
185 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
186 }
187 }
188 },
189 USER: {
190 get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
191 get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
192 },
193 TRANSCODING: {
194 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
195 get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
536598cf 196 get ALLOW_AUDIO_FILES () { return config.get<boolean>('transcoding.allow_audio_files') },
6dd9de95 197 get THREADS () { return config.get<number>('transcoding.threads') },
9129b769 198 get CONCURRENCY () { return config.get<number>('transcoding.concurrency') },
1896bca0 199 get PROFILE () { return config.get<string>('transcoding.profile') },
6dd9de95 200 RESOLUTIONS: {
5c7d6508 201 get '0p' () { return config.get<boolean>('transcoding.resolutions.0p') },
6dd9de95
C
202 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
203 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
204 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
205 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
00aa1f0d 206 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') },
b7085c71 207 get '1440p' () { return config.get<boolean>('transcoding.resolutions.1440p') },
00aa1f0d 208 get '2160p' () { return config.get<boolean>('transcoding.resolutions.2160p') }
6dd9de95
C
209 },
210 HLS: {
211 get ENABLED () { return config.get<boolean>('transcoding.hls.enabled') }
d7a25329
C
212 },
213 WEBTORRENT: {
214 get ENABLED () { return config.get<boolean>('transcoding.webtorrent.enabled') }
6dd9de95
C
215 }
216 },
c6c0fa6c
C
217 LIVE: {
218 get ENABLED () { return config.get<boolean>('live.enabled') },
fb719404
C
219
220 get MAX_DURATION () { return parseDurationToMs(config.get<string>('live.max_duration')) },
a056ca48
C
221 get MAX_INSTANCE_LIVES () { return config.get<number>('live.max_instance_lives') },
222 get MAX_USER_LIVES () { return config.get<number>('live.max_user_lives') },
223
fb719404 224 get ALLOW_REPLAY () { return config.get<boolean>('live.allow_replay') },
c6c0fa6c
C
225
226 RTMP: {
227 get PORT () { return config.get<number>('live.rtmp.port') }
228 },
229
230 TRANSCODING: {
231 get ENABLED () { return config.get<boolean>('live.transcoding.enabled') },
232 get THREADS () { return config.get<number>('live.transcoding.threads') },
1896bca0 233 get PROFILE () { return config.get<string>('live.transcoding.profile') },
c6c0fa6c
C
234
235 RESOLUTIONS: {
236 get '240p' () { return config.get<boolean>('live.transcoding.resolutions.240p') },
237 get '360p' () { return config.get<boolean>('live.transcoding.resolutions.360p') },
238 get '480p' () { return config.get<boolean>('live.transcoding.resolutions.480p') },
239 get '720p' () { return config.get<boolean>('live.transcoding.resolutions.720p') },
240 get '1080p' () { return config.get<boolean>('live.transcoding.resolutions.1080p') },
b7085c71 241 get '1440p' () { return config.get<boolean>('live.transcoding.resolutions.1440p') },
c6c0fa6c
C
242 get '2160p' () { return config.get<boolean>('live.transcoding.resolutions.2160p') }
243 }
244 }
245 },
6dd9de95
C
246 IMPORT: {
247 VIDEOS: {
9129b769
C
248 get CONCURRENCY () { return config.get<number>('import.videos.concurrency') },
249
6dd9de95 250 HTTP: {
be7ca0c6 251 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') },
e0409585 252 get FORCE_IPV4 () { return config.get<boolean>('import.videos.http.force_ipv4') },
be7ca0c6
C
253 PROXY: {
254 get ENABLED () { return config.get<boolean>('import.videos.http.proxy.enabled') },
255 get URL () { return config.get<string>('import.videos.http.proxy.url') }
256 }
6dd9de95
C
257 },
258 TORRENT: {
259 get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
260 }
261 }
262 },
263 AUTO_BLACKLIST: {
264 VIDEOS: {
265 OF_USERS: {
266 get ENABLED () { return config.get<boolean>('auto_blacklist.videos.of_users.enabled') }
267 }
268 }
269 },
270 CACHE: {
271 PREVIEWS: {
272 get SIZE () { return config.get<number>('cache.previews.size') }
273 },
274 VIDEO_CAPTIONS: {
275 get SIZE () { return config.get<number>('cache.captions.size') }
90a8bd30
C
276 },
277 TORRENTS: {
278 get SIZE () { return config.get<number>('cache.torrents.size') }
6dd9de95
C
279 }
280 },
281 INSTANCE: {
282 get NAME () { return config.get<string>('instance.name') },
283 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
284 get DESCRIPTION () { return config.get<string>('instance.description') },
285 get TERMS () { return config.get<string>('instance.terms') },
ccc00cb2
C
286 get CODE_OF_CONDUCT () { return config.get<string>('instance.code_of_conduct') },
287
8ae03c37
C
288 get CREATION_REASON () { return config.get<string>('instance.creation_reason') },
289
ccc00cb2
C
290 get MODERATION_INFORMATION () { return config.get<string>('instance.moderation_information') },
291 get ADMINISTRATOR () { return config.get<string>('instance.administrator') },
292 get MAINTENANCE_LIFETIME () { return config.get<string>('instance.maintenance_lifetime') },
293 get BUSINESS_MODEL () { return config.get<string>('instance.business_model') },
be04c6fd 294 get HARDWARE_INFORMATION () { return config.get<string>('instance.hardware_information') },
ccc00cb2
C
295
296 get LANGUAGES () { return config.get<string[]>('instance.languages') || [] },
297 get CATEGORIES () { return config.get<number[]>('instance.categories') || [] },
298
6dd9de95 299 get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
6dd9de95 300 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
3da68f0a
RK
301
302 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
3da68f0a 303
6dd9de95
C
304 CUSTOMIZATIONS: {
305 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
306 get CSS () { return config.get<string>('instance.customizations.css') }
307 },
308 get ROBOTS () { return config.get<string>('instance.robots') },
309 get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
310 get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
311 },
312 SERVICES: {
313 TWITTER: {
314 get USERNAME () { return config.get<string>('services.twitter.username') },
315 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
316 }
317 },
318 FOLLOWERS: {
319 INSTANCE: {
320 get ENABLED () { return config.get<boolean>('followers.instance.enabled') },
321 get MANUAL_APPROVAL () { return config.get<boolean>('followers.instance.manual_approval') }
322 }
7cd4d2ba 323 },
8424c402
C
324 FOLLOWINGS: {
325 INSTANCE: {
326 AUTO_FOLLOW_BACK: {
327 get ENABLED () {
328 return config.get<boolean>('followings.instance.auto_follow_back.enabled')
329 }
330 },
331 AUTO_FOLLOW_INDEX: {
332 get ENABLED () {
333 return config.get<boolean>('followings.instance.auto_follow_index.enabled')
334 },
335 get INDEX_URL () {
336 return config.get<string>('followings.instance.auto_follow_index.index_url')
337 }
338 }
339 }
340 },
7cd4d2ba
C
341 THEME: {
342 get DEFAULT () { return config.get<string>('theme.default') }
72c33e71
C
343 },
344 BROADCAST_MESSAGE: {
345 get ENABLED () { return config.get<boolean>('broadcast_message.enabled') },
346 get MESSAGE () { return config.get<string>('broadcast_message.message') },
347 get LEVEL () { return config.get<BroadcastMessageLevel>('broadcast_message.level') },
348 get DISMISSABLE () { return config.get<boolean>('broadcast_message.dismissable') }
5fb2e288
C
349 },
350 SEARCH: {
351 REMOTE_URI: {
56df7815
C
352 get USERS () { return config.get<boolean>('search.remote_uri.users') },
353 get ANONYMOUS () { return config.get<boolean>('search.remote_uri.anonymous') }
5fb2e288
C
354 },
355 SEARCH_INDEX: {
356 get ENABLED () { return config.get<boolean>('search.search_index.enabled') },
357 get URL () { return config.get<string>('search.search_index.url') },
358 get DISABLE_LOCAL_SEARCH () { return config.get<boolean>('search.search_index.disable_local_search') },
359 get IS_DEFAULT_SEARCH () { return config.get<boolean>('search.search_index.is_default_search') }
360 }
6dd9de95
C
361 }
362}
363
364function registerConfigChangedHandler (fun: Function) {
365 configChangedHandlers.push(fun)
366}
367
4c1c1709 368function isEmailEnabled () {
448487a6
C
369 if (CONFIG.SMTP.TRANSPORT === 'sendmail' && CONFIG.SMTP.SENDMAIL) return true
370
371 if (CONFIG.SMTP.TRANSPORT === 'smtp' && CONFIG.SMTP.HOSTNAME && CONFIG.SMTP.PORT) return true
372
373 return false
4c1c1709
C
374}
375
6dd9de95
C
376// ---------------------------------------------------------------------------
377
378export {
379 CONFIG,
4c1c1709
C
380 registerConfigChangedHandler,
381 isEmailEnabled
6dd9de95
C
382}
383
384// ---------------------------------------------------------------------------
385
386function getLocalConfigFilePath () {
387 const configSources = config.util.getConfigSources()
388 if (configSources.length === 0) throw new Error('Invalid config source.')
389
390 let filename = 'local'
391 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
392 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
393
a1587156 394 return join(dirname(configSources[0].name), filename + '.json')
6dd9de95
C
395}
396
b764380a 397function buildVideosRedundancy (objs: any[]): VideosRedundancyStrategy[] {
6dd9de95
C
398 if (!objs) return []
399
400 if (!Array.isArray(objs)) return objs
401
402 return objs.map(obj => {
403 return Object.assign({}, obj, {
8f0bc73d 404 minLifetime: parseDurationToMs(obj.min_lifetime),
6dd9de95
C
405 size: bytes.parse(obj.size),
406 minViews: obj.min_views
407 })
408 })
409}
410
411export function reloadConfig () {
412
413 function directory () {
414 if (process.env.NODE_CONFIG_DIR) {
415 return process.env.NODE_CONFIG_DIR
416 }
417
418 return join(root(), 'config')
419 }
420
421 function purge () {
422 for (const fileName in require.cache) {
bdd428a6 423 if (fileName.includes(directory()) === false) {
6dd9de95
C
424 continue
425 }
426
427 delete require.cache[fileName]
428 }
429
430 delete require.cache[require.resolve('config')]
431 }
432
433 purge()
434
435 config = require('config')
436
437 for (const configChangedHandler of configChangedHandlers) {
438 configChangedHandler()
439 }
440}