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 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
69 isNSFW: CONFIG.INSTANCE.IS_NSFW,
70 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
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
190 enabled: CONFIG.TRACKER.ENABLED
196 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
202 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
203 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
204 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
205 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
209 return res.json(json)
212 function getAbout (req: express.Request, res: express.Response) {
213 const about: About = {
215 name: CONFIG.INSTANCE.NAME,
216 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
217 description: CONFIG.INSTANCE.DESCRIPTION,
218 terms: CONFIG.INSTANCE.TERMS,
219 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
221 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
223 creationReason: CONFIG.INSTANCE.CREATION_REASON,
224 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
225 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
226 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
227 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
229 languages: CONFIG.INSTANCE.LANGUAGES,
230 categories: CONFIG.INSTANCE.CATEGORIES
234 return res.json(about).end()
237 function getCustomConfig (req: express.Request, res: express.Response) {
238 const data = customConfig()
240 return res.json(data).end()
243 async function deleteCustomConfig (req: express.Request, res: express.Response) {
244 await remove(CONFIG.CUSTOM_FILE)
246 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
249 ClientHtml.invalidCache()
251 const data = customConfig()
253 return res.json(data)
256 async function updateCustomConfig (req: express.Request, res: express.Response) {
257 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
259 // camelCase to snake_case key + Force number conversion
260 const toUpdateJSON = convertCustomConfigBody(req.body)
262 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
265 ClientHtml.invalidCache()
267 const data = customConfig()
270 getAuditIdFromRes(res),
271 new CustomConfigAuditView(data),
272 oldCustomConfigAuditKeys
275 return res.json(data)
278 function getRegisteredThemes () {
279 return PluginManager.Instance.getRegisteredThemes()
283 description: t.description,
285 clientScripts: t.clientScripts
289 function getRegisteredPlugins () {
290 return PluginManager.Instance.getRegisteredPlugins()
294 description: p.description,
295 clientScripts: p.clientScripts
299 function getIdAndPassAuthPlugins () {
300 const result: RegisteredIdAndPassAuthConfig[] = []
302 for (const p of PluginManager.Instance.getIdAndPassAuths()) {
303 for (const auth of p.idAndPassAuths) {
308 authName: auth.authName,
309 weight: auth.getWeight()
317 function getExternalAuthsPlugins () {
318 const result: RegisteredExternalAuthConfig[] = []
320 for (const p of PluginManager.Instance.getExternalAuths()) {
321 for (const auth of p.externalAuths) {
326 authName: auth.authName,
327 authDisplayName: auth.authDisplayName()
335 // ---------------------------------------------------------------------------
339 getRegisteredPlugins,
343 // ---------------------------------------------------------------------------
345 function customConfig (): CustomConfig {
348 name: CONFIG.INSTANCE.NAME,
349 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
350 description: CONFIG.INSTANCE.DESCRIPTION,
351 terms: CONFIG.INSTANCE.TERMS,
352 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
354 creationReason: CONFIG.INSTANCE.CREATION_REASON,
355 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
356 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
357 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
358 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
359 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
361 languages: CONFIG.INSTANCE.LANGUAGES,
362 categories: CONFIG.INSTANCE.CATEGORIES,
364 isNSFW: CONFIG.INSTANCE.IS_NSFW,
365 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
366 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
368 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
369 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
373 default: CONFIG.THEME.DEFAULT
377 username: CONFIG.SERVICES.TWITTER.USERNAME,
378 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
383 size: CONFIG.CACHE.PREVIEWS.SIZE
386 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
390 enabled: CONFIG.SIGNUP.ENABLED,
391 limit: CONFIG.SIGNUP.LIMIT,
392 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
395 email: CONFIG.ADMIN.EMAIL
398 enabled: CONFIG.CONTACT_FORM.ENABLED
401 videoQuota: CONFIG.USER.VIDEO_QUOTA,
402 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
405 enabled: CONFIG.TRANSCODING.ENABLED,
406 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
407 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
408 threads: CONFIG.TRANSCODING.THREADS,
410 '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
411 '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
412 '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
413 '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
414 '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
415 '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
416 '1440p': CONFIG.TRANSCODING.RESOLUTIONS['1440p'],
417 '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
420 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
423 enabled: CONFIG.TRANSCODING.HLS.ENABLED
427 enabled: CONFIG.LIVE.ENABLED,
428 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
429 maxDuration: CONFIG.LIVE.MAX_DURATION,
430 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
431 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
433 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
434 threads: CONFIG.LIVE.TRANSCODING.THREADS,
436 '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],
437 '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],
438 '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],
439 '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],
440 '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],
441 '1440p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1440p'],
442 '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p']
449 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
452 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
459 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
465 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
466 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
472 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
476 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
477 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
482 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
483 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
484 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
485 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
489 users: CONFIG.SEARCH.REMOTE_URI.USERS,
490 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
493 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
494 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
495 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
496 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
502 function convertCustomConfigBody (body: CustomConfig) {
503 function keyConverter (k: string) {
504 // Transcoding resolutions exception
505 if (/^\d{3,4}p$/.exec(k)) return k
506 if (k === '0p') return k
511 function valueConverter (v: any) {
512 if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
517 return objectConverter(body, keyConverter, valueConverter)