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'
22 const configRouter = express.Router()
24 const auditLogger = auditLoggerFactory('config')
26 configRouter.get('/about', getAbout)
28 asyncMiddleware(getConfig)
31 configRouter.get('/custom',
33 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
36 configRouter.put('/custom',
38 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
39 customConfigUpdateValidator,
40 asyncMiddleware(updateCustomConfig)
42 configRouter.delete('/custom',
44 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
45 asyncMiddleware(deleteCustomConfig)
48 let serverCommit: string
50 async function getConfig (req: express.Request, res: express.Response) {
51 const { allowed } = await Hooks.wrapPromiseFun(
56 'filter:api.user.signup.allowed.result'
59 const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip)
60 const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
62 if (serverCommit === undefined) serverCommit = await getServerCommit()
64 const json: ServerConfig = {
66 name: CONFIG.INSTANCE.NAME,
67 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
68 isNSFW: CONFIG.INSTANCE.IS_NSFW,
69 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
70 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
72 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
73 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
78 users: CONFIG.SEARCH.REMOTE_URI.USERS,
79 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
82 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
83 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
84 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
85 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
89 registered: getRegisteredPlugins(),
90 registeredExternalAuths: getExternalAuthsPlugins(),
91 registeredIdAndPassAuths: getIdAndPassAuthPlugins()
94 registered: getRegisteredThemes(),
98 enabled: isEmailEnabled()
101 enabled: CONFIG.CONTACT_FORM.ENABLED
103 serverVersion: PEERTUBE_VERSION,
108 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
112 enabled: CONFIG.TRANSCODING.HLS.ENABLED
115 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
117 enabledResolutions: getEnabledResolutions('vod')
120 enabled: CONFIG.LIVE.ENABLED,
122 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
123 maxDuration: CONFIG.LIVE.MAX_DURATION,
124 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
125 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
128 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
129 enabledResolutions: getEnabledResolutions('live')
133 port: CONFIG.LIVE.RTMP.PORT
139 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
142 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
149 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
156 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
158 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
163 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
165 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
169 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
175 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
177 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
181 videoQuota: CONFIG.USER.VIDEO_QUOTA,
182 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
186 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS,
188 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
189 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
194 enabled: CONFIG.TRACKER.ENABLED
200 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
206 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
207 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
208 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
209 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
213 return res.json(json)
216 function getAbout (req: express.Request, res: express.Response) {
217 const about: About = {
219 name: CONFIG.INSTANCE.NAME,
220 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
221 description: CONFIG.INSTANCE.DESCRIPTION,
222 terms: CONFIG.INSTANCE.TERMS,
223 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
225 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
227 creationReason: CONFIG.INSTANCE.CREATION_REASON,
228 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
229 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
230 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
231 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
233 languages: CONFIG.INSTANCE.LANGUAGES,
234 categories: CONFIG.INSTANCE.CATEGORIES
238 return res.json(about).end()
241 function getCustomConfig (req: express.Request, res: express.Response) {
242 const data = customConfig()
244 return res.json(data).end()
247 async function deleteCustomConfig (req: express.Request, res: express.Response) {
248 await remove(CONFIG.CUSTOM_FILE)
250 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
253 ClientHtml.invalidCache()
255 const data = customConfig()
257 return res.json(data)
260 async function updateCustomConfig (req: express.Request, res: express.Response) {
261 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
263 // camelCase to snake_case key + Force number conversion
264 const toUpdateJSON = convertCustomConfigBody(req.body)
266 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
269 ClientHtml.invalidCache()
271 const data = customConfig()
274 getAuditIdFromRes(res),
275 new CustomConfigAuditView(data),
276 oldCustomConfigAuditKeys
279 return res.json(data)
282 function getRegisteredThemes () {
283 return PluginManager.Instance.getRegisteredThemes()
287 description: t.description,
289 clientScripts: t.clientScripts
293 function getRegisteredPlugins () {
294 return PluginManager.Instance.getRegisteredPlugins()
298 description: p.description,
299 clientScripts: p.clientScripts
303 function getIdAndPassAuthPlugins () {
304 const result: RegisteredIdAndPassAuthConfig[] = []
306 for (const p of PluginManager.Instance.getIdAndPassAuths()) {
307 for (const auth of p.idAndPassAuths) {
312 authName: auth.authName,
313 weight: auth.getWeight()
321 function getExternalAuthsPlugins () {
322 const result: RegisteredExternalAuthConfig[] = []
324 for (const p of PluginManager.Instance.getExternalAuths()) {
325 for (const auth of p.externalAuths) {
330 authName: auth.authName,
331 authDisplayName: auth.authDisplayName()
339 // ---------------------------------------------------------------------------
343 getRegisteredPlugins,
347 // ---------------------------------------------------------------------------
349 function customConfig (): CustomConfig {
352 name: CONFIG.INSTANCE.NAME,
353 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
354 description: CONFIG.INSTANCE.DESCRIPTION,
355 terms: CONFIG.INSTANCE.TERMS,
356 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
358 creationReason: CONFIG.INSTANCE.CREATION_REASON,
359 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
360 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
361 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
362 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
363 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
365 languages: CONFIG.INSTANCE.LANGUAGES,
366 categories: CONFIG.INSTANCE.CATEGORIES,
368 isNSFW: CONFIG.INSTANCE.IS_NSFW,
369 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
371 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
374 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
375 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
379 default: CONFIG.THEME.DEFAULT
383 username: CONFIG.SERVICES.TWITTER.USERNAME,
384 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
389 size: CONFIG.CACHE.PREVIEWS.SIZE
392 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
396 enabled: CONFIG.SIGNUP.ENABLED,
397 limit: CONFIG.SIGNUP.LIMIT,
398 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
401 email: CONFIG.ADMIN.EMAIL
404 enabled: CONFIG.CONTACT_FORM.ENABLED
407 videoQuota: CONFIG.USER.VIDEO_QUOTA,
408 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
411 enabled: CONFIG.TRANSCODING.ENABLED,
412 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
413 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
414 threads: CONFIG.TRANSCODING.THREADS,
416 '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
417 '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
418 '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
419 '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
420 '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
421 '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
422 '1440p': CONFIG.TRANSCODING.RESOLUTIONS['1440p'],
423 '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
426 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
429 enabled: CONFIG.TRANSCODING.HLS.ENABLED
433 enabled: CONFIG.LIVE.ENABLED,
434 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
435 maxDuration: CONFIG.LIVE.MAX_DURATION,
436 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
437 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
439 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
440 threads: CONFIG.LIVE.TRANSCODING.THREADS,
442 '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],
443 '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],
444 '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],
445 '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],
446 '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],
447 '1440p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1440p'],
448 '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p']
455 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
458 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
465 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
466 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
473 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
479 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
480 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
486 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
490 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
491 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
496 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
497 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
498 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
499 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
503 users: CONFIG.SEARCH.REMOTE_URI.USERS,
504 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
507 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
508 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
509 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
510 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
516 function convertCustomConfigBody (body: CustomConfig) {
517 function keyConverter (k: string) {
518 // Transcoding resolutions exception
519 if (/^\d{3,4}p$/.exec(k)) return k
520 if (k === '0p') return k
525 function valueConverter (v: any) {
526 if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
531 return objectConverter(body, keyConverter, valueConverter)