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 { CONFIG, isEmailEnabled, reloadConfig } from '../../initializers/config'
14 import { CONSTRAINTS_FIELDS, DEFAULT_THEME_NAME, PEERTUBE_VERSION } from '../../initializers/constants'
15 import { ClientHtml } from '../../lib/client-html'
16 import { PluginManager } from '../../lib/plugins/plugin-manager'
17 import { getThemeOrDefault } from '../../lib/plugins/theme-utils'
18 import { asyncMiddleware, authenticate, ensureUserHasRight } from '../../middlewares'
19 import { customConfigUpdateValidator } from '../../middlewares/validators/config'
21 const configRouter = express.Router()
23 const auditLogger = auditLoggerFactory('config')
25 configRouter.get('/about', getAbout)
27 asyncMiddleware(getConfig)
30 configRouter.get('/custom',
32 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
35 configRouter.put('/custom',
37 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
38 customConfigUpdateValidator,
39 asyncMiddleware(updateCustomConfig)
41 configRouter.delete('/custom',
43 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
44 asyncMiddleware(deleteCustomConfig)
47 let serverCommit: string
49 async function getConfig (req: express.Request, res: express.Response) {
50 const { allowed } = await Hooks.wrapPromiseFun(
55 'filter:api.user.signup.allowed.result'
58 const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip)
59 const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
61 if (serverCommit === undefined) serverCommit = await getServerCommit()
63 const json: ServerConfig = {
65 name: CONFIG.INSTANCE.NAME,
66 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
67 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
68 isNSFW: CONFIG.INSTANCE.IS_NSFW,
69 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
71 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
72 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
77 users: CONFIG.SEARCH.REMOTE_URI.USERS,
78 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
81 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
82 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
83 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
84 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
88 registered: getRegisteredPlugins(),
89 registeredExternalAuths: getExternalAuthsPlugins(),
90 registeredIdAndPassAuths: getIdAndPassAuthPlugins()
93 registered: getRegisteredThemes(),
97 enabled: isEmailEnabled()
100 enabled: CONFIG.CONTACT_FORM.ENABLED
102 serverVersion: PEERTUBE_VERSION,
107 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
111 enabled: CONFIG.TRANSCODING.HLS.ENABLED
114 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
116 enabledResolutions: getEnabledResolutions('vod')
119 enabled: CONFIG.LIVE.ENABLED,
121 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
122 maxDuration: CONFIG.LIVE.MAX_DURATION,
123 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
124 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
127 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
128 enabledResolutions: getEnabledResolutions('live')
132 port: CONFIG.LIVE.RTMP.PORT
138 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
141 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
148 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
155 max: CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max
157 extensions: CONSTRAINTS_FIELDS.ACTORS.AVATAR.EXTNAME
162 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
164 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
168 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
174 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
176 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
180 videoQuota: CONFIG.USER.VIDEO_QUOTA,
181 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
185 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
189 enabled: CONFIG.TRACKER.ENABLED
195 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
201 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
202 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
203 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
204 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
208 return res.json(json)
211 function getAbout (req: express.Request, res: express.Response) {
212 const about: About = {
214 name: CONFIG.INSTANCE.NAME,
215 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
216 description: CONFIG.INSTANCE.DESCRIPTION,
217 terms: CONFIG.INSTANCE.TERMS,
218 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
220 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
222 creationReason: CONFIG.INSTANCE.CREATION_REASON,
223 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
224 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
225 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
226 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
228 languages: CONFIG.INSTANCE.LANGUAGES,
229 categories: CONFIG.INSTANCE.CATEGORIES
233 return res.json(about).end()
236 function getCustomConfig (req: express.Request, res: express.Response) {
237 const data = customConfig()
239 return res.json(data).end()
242 async function deleteCustomConfig (req: express.Request, res: express.Response) {
243 await remove(CONFIG.CUSTOM_FILE)
245 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
248 ClientHtml.invalidCache()
250 const data = customConfig()
252 return res.json(data)
255 async function updateCustomConfig (req: express.Request, res: express.Response) {
256 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
258 // camelCase to snake_case key + Force number conversion
259 const toUpdateJSON = convertCustomConfigBody(req.body)
261 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
264 ClientHtml.invalidCache()
266 const data = customConfig()
269 getAuditIdFromRes(res),
270 new CustomConfigAuditView(data),
271 oldCustomConfigAuditKeys
274 return res.json(data)
277 function getRegisteredThemes () {
278 return PluginManager.Instance.getRegisteredThemes()
282 description: t.description,
284 clientScripts: t.clientScripts
288 function getEnabledResolutions (type: 'vod' | 'live') {
289 const transcoding = type === 'vod'
291 : CONFIG.LIVE.TRANSCODING
293 return Object.keys(transcoding.RESOLUTIONS)
294 .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true)
295 .map(r => parseInt(r, 10))
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 getEnabledResolutions,
349 getRegisteredPlugins,
353 // ---------------------------------------------------------------------------
355 function customConfig (): CustomConfig {
358 name: CONFIG.INSTANCE.NAME,
359 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
360 description: CONFIG.INSTANCE.DESCRIPTION,
361 terms: CONFIG.INSTANCE.TERMS,
362 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
364 creationReason: CONFIG.INSTANCE.CREATION_REASON,
365 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
366 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
367 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
368 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
369 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
371 languages: CONFIG.INSTANCE.LANGUAGES,
372 categories: CONFIG.INSTANCE.CATEGORIES,
374 isNSFW: CONFIG.INSTANCE.IS_NSFW,
375 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
376 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
378 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
379 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
383 default: CONFIG.THEME.DEFAULT
387 username: CONFIG.SERVICES.TWITTER.USERNAME,
388 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
393 size: CONFIG.CACHE.PREVIEWS.SIZE
396 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
400 enabled: CONFIG.SIGNUP.ENABLED,
401 limit: CONFIG.SIGNUP.LIMIT,
402 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
405 email: CONFIG.ADMIN.EMAIL
408 enabled: CONFIG.CONTACT_FORM.ENABLED
411 videoQuota: CONFIG.USER.VIDEO_QUOTA,
412 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
415 enabled: CONFIG.TRANSCODING.ENABLED,
416 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
417 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
418 threads: CONFIG.TRANSCODING.THREADS,
420 '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
421 '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
422 '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
423 '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
424 '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
425 '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
426 '1440p': CONFIG.TRANSCODING.RESOLUTIONS['1440p'],
427 '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
430 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
433 enabled: CONFIG.TRANSCODING.HLS.ENABLED
437 enabled: CONFIG.LIVE.ENABLED,
438 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
439 maxDuration: CONFIG.LIVE.MAX_DURATION,
440 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
441 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
443 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
444 threads: CONFIG.LIVE.TRANSCODING.THREADS,
446 '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],
447 '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],
448 '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],
449 '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],
450 '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],
451 '1440p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1440p'],
452 '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p']
459 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
462 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
469 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
475 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
476 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
482 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
486 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
487 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
492 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
493 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
494 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
495 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
499 users: CONFIG.SEARCH.REMOTE_URI.USERS,
500 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
503 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
504 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
505 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
506 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
512 function convertCustomConfigBody (body: CustomConfig) {
513 function keyConverter (k: string) {
514 // Transcoding resolutions exception
515 if (/^\d{3,4}p$/.exec(k)) return k
516 if (k === '0p') return k
521 function valueConverter (v: any) {
522 if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
527 return objectConverter(body, keyConverter, valueConverter)