1 import { Hooks } from '@server/lib/plugins/hooks'
2 import * as express from 'express'
3 import { remove, writeJSON } from 'fs-extra'
4 import { snakeCase } from 'lodash'
5 import validator from 'validator'
6 import { RegisteredExternalAuthConfig, RegisteredIdAndPassAuthConfig, ServerConfig, UserRight } from '../../../shared'
7 import { About } from '../../../shared/models/server/about.model'
8 import { CustomConfig } from '../../../shared/models/server/custom-config.model'
9 import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger'
10 import { objectConverter } from '../../helpers/core-utils'
11 import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/signup'
12 import { getServerCommit } from '../../helpers/utils'
13 import { getEnabledResolutions } from '../../lib/video-transcoding'
14 import { CONFIG, isEmailEnabled, reloadConfig } from '../../initializers/config'
15 import { CONSTRAINTS_FIELDS, DEFAULT_THEME_NAME, PEERTUBE_VERSION } from '../../initializers/constants'
16 import { ClientHtml } from '../../lib/client-html'
17 import { PluginManager } from '../../lib/plugins/plugin-manager'
18 import { getThemeOrDefault } from '../../lib/plugins/theme-utils'
19 import { asyncMiddleware, authenticate, ensureUserHasRight } from '../../middlewares'
20 import { customConfigUpdateValidator } from '../../middlewares/validators/config'
21 import { VideoTranscodingProfilesManager } from '@server/lib/video-transcoding-profiles'
23 const configRouter = express.Router()
25 const auditLogger = auditLoggerFactory('config')
27 configRouter.get('/about', getAbout)
29 asyncMiddleware(getConfig)
32 configRouter.get('/custom',
34 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
37 configRouter.put('/custom',
39 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
40 customConfigUpdateValidator,
41 asyncMiddleware(updateCustomConfig)
43 configRouter.delete('/custom',
45 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
46 asyncMiddleware(deleteCustomConfig)
49 let serverCommit: string
51 async function getConfig (req: express.Request, res: express.Response) {
52 const { allowed } = await Hooks.wrapPromiseFun(
57 'filter:api.user.signup.allowed.result'
60 const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip)
61 const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
63 if (serverCommit === undefined) serverCommit = await getServerCommit()
65 const json: ServerConfig = {
67 name: CONFIG.INSTANCE.NAME,
68 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
69 isNSFW: CONFIG.INSTANCE.IS_NSFW,
70 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
71 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
73 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
74 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
79 users: CONFIG.SEARCH.REMOTE_URI.USERS,
80 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
83 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
84 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
85 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
86 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
90 registered: getRegisteredPlugins(),
91 registeredExternalAuths: getExternalAuthsPlugins(),
92 registeredIdAndPassAuths: getIdAndPassAuthPlugins()
95 registered: getRegisteredThemes(),
99 enabled: isEmailEnabled()
102 enabled: CONFIG.CONTACT_FORM.ENABLED
104 serverVersion: PEERTUBE_VERSION,
109 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
113 enabled: CONFIG.TRANSCODING.HLS.ENABLED
116 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
118 enabledResolutions: getEnabledResolutions('vod'),
119 profile: CONFIG.TRANSCODING.PROFILE,
120 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('vod')
123 enabled: CONFIG.LIVE.ENABLED,
125 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
126 maxDuration: CONFIG.LIVE.MAX_DURATION,
127 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
128 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
131 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
132 enabledResolutions: getEnabledResolutions('live'),
133 profile: CONFIG.LIVE.TRANSCODING.PROFILE,
134 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('live')
138 port: CONFIG.LIVE.RTMP.PORT
144 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
147 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
154 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
161 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
163 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
168 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
170 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
174 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
180 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
182 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
186 videoQuota: CONFIG.USER.VIDEO_QUOTA,
187 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
191 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS,
193 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
194 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
199 enabled: CONFIG.TRACKER.ENABLED
205 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
211 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
212 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
213 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
214 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
218 return res.json(json)
221 function getAbout (req: express.Request, res: express.Response) {
222 const about: About = {
224 name: CONFIG.INSTANCE.NAME,
225 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
226 description: CONFIG.INSTANCE.DESCRIPTION,
227 terms: CONFIG.INSTANCE.TERMS,
228 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
230 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
232 creationReason: CONFIG.INSTANCE.CREATION_REASON,
233 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
234 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
235 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
236 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
238 languages: CONFIG.INSTANCE.LANGUAGES,
239 categories: CONFIG.INSTANCE.CATEGORIES
243 return res.json(about).end()
246 function getCustomConfig (req: express.Request, res: express.Response) {
247 const data = customConfig()
249 return res.json(data).end()
252 async function deleteCustomConfig (req: express.Request, res: express.Response) {
253 await remove(CONFIG.CUSTOM_FILE)
255 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
258 ClientHtml.invalidCache()
260 const data = customConfig()
262 return res.json(data)
265 async function updateCustomConfig (req: express.Request, res: express.Response) {
266 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
268 // camelCase to snake_case key + Force number conversion
269 const toUpdateJSON = convertCustomConfigBody(req.body)
271 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
274 ClientHtml.invalidCache()
276 const data = customConfig()
279 getAuditIdFromRes(res),
280 new CustomConfigAuditView(data),
281 oldCustomConfigAuditKeys
284 return res.json(data)
287 function getRegisteredThemes () {
288 return PluginManager.Instance.getRegisteredThemes()
292 description: t.description,
294 clientScripts: t.clientScripts
298 function getRegisteredPlugins () {
299 return PluginManager.Instance.getRegisteredPlugins()
303 description: p.description,
304 clientScripts: p.clientScripts
308 function getIdAndPassAuthPlugins () {
309 const result: RegisteredIdAndPassAuthConfig[] = []
311 for (const p of PluginManager.Instance.getIdAndPassAuths()) {
312 for (const auth of p.idAndPassAuths) {
317 authName: auth.authName,
318 weight: auth.getWeight()
326 function getExternalAuthsPlugins () {
327 const result: RegisteredExternalAuthConfig[] = []
329 for (const p of PluginManager.Instance.getExternalAuths()) {
330 for (const auth of p.externalAuths) {
335 authName: auth.authName,
336 authDisplayName: auth.authDisplayName()
344 // ---------------------------------------------------------------------------
348 getRegisteredPlugins,
352 // ---------------------------------------------------------------------------
354 function customConfig (): CustomConfig {
357 name: CONFIG.INSTANCE.NAME,
358 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
359 description: CONFIG.INSTANCE.DESCRIPTION,
360 terms: CONFIG.INSTANCE.TERMS,
361 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
363 creationReason: CONFIG.INSTANCE.CREATION_REASON,
364 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
365 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
366 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
367 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
368 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
370 languages: CONFIG.INSTANCE.LANGUAGES,
371 categories: CONFIG.INSTANCE.CATEGORIES,
373 isNSFW: CONFIG.INSTANCE.IS_NSFW,
374 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
376 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
379 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
380 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
384 default: CONFIG.THEME.DEFAULT
388 username: CONFIG.SERVICES.TWITTER.USERNAME,
389 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
394 size: CONFIG.CACHE.PREVIEWS.SIZE
397 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
400 size: CONFIG.CACHE.TORRENTS.SIZE
404 enabled: CONFIG.SIGNUP.ENABLED,
405 limit: CONFIG.SIGNUP.LIMIT,
406 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
409 email: CONFIG.ADMIN.EMAIL
412 enabled: CONFIG.CONTACT_FORM.ENABLED
415 videoQuota: CONFIG.USER.VIDEO_QUOTA,
416 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
419 enabled: CONFIG.TRANSCODING.ENABLED,
420 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
421 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
422 threads: CONFIG.TRANSCODING.THREADS,
423 concurrency: CONFIG.TRANSCODING.CONCURRENCY,
424 profile: CONFIG.TRANSCODING.PROFILE,
426 '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
427 '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
428 '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
429 '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
430 '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
431 '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
432 '1440p': CONFIG.TRANSCODING.RESOLUTIONS['1440p'],
433 '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
436 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
439 enabled: CONFIG.TRANSCODING.HLS.ENABLED
443 enabled: CONFIG.LIVE.ENABLED,
444 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
445 maxDuration: CONFIG.LIVE.MAX_DURATION,
446 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
447 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
449 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
450 threads: CONFIG.LIVE.TRANSCODING.THREADS,
451 profile: CONFIG.LIVE.TRANSCODING.PROFILE,
453 '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],
454 '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],
455 '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],
456 '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],
457 '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],
458 '1440p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1440p'],
459 '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p']
465 concurrency: CONFIG.IMPORT.VIDEOS.CONCURRENCY,
467 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
470 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
477 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
478 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
485 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
491 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
492 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
498 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
502 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
503 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
508 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
509 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
510 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
511 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
515 users: CONFIG.SEARCH.REMOTE_URI.USERS,
516 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
519 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
520 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
521 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
522 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
528 function convertCustomConfigBody (body: CustomConfig) {
529 function keyConverter (k: string) {
530 // Transcoding resolutions exception
531 if (/^\d{3,4}p$/.exec(k)) return k
532 if (k === '0p') return k
537 function valueConverter (v: any) {
538 if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
543 return objectConverter(body, keyConverter, valueConverter)