1 import express from 'express'
2 import { remove, writeJSON } from 'fs-extra'
3 import { snakeCase } from 'lodash'
4 import validator from 'validator'
5 import { ServerConfigManager } from '@server/lib/server-config-manager'
6 import { About, CustomConfig, UserRight } from '@shared/models'
7 import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger'
8 import { objectConverter } from '../../helpers/core-utils'
9 import { CONFIG, reloadConfig } from '../../initializers/config'
10 import { ClientHtml } from '../../lib/client-html'
11 import { asyncMiddleware, authenticate, ensureUserHasRight, openapiOperationDoc } from '../../middlewares'
12 import { customConfigUpdateValidator, ensureConfigIsEditable } from '../../middlewares/validators/config'
14 const configRouter = express.Router()
16 const auditLogger = auditLoggerFactory('config')
19 openapiOperationDoc({ operationId: 'getConfig' }),
20 asyncMiddleware(getConfig)
23 configRouter.get('/about',
24 openapiOperationDoc({ operationId: 'getAbout' }),
28 configRouter.get('/custom',
29 openapiOperationDoc({ operationId: 'getCustomConfig' }),
31 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
35 configRouter.put('/custom',
36 openapiOperationDoc({ operationId: 'putCustomConfig' }),
38 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
39 ensureConfigIsEditable,
40 customConfigUpdateValidator,
41 asyncMiddleware(updateCustomConfig)
44 configRouter.delete('/custom',
45 openapiOperationDoc({ operationId: 'delCustomConfig' }),
47 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
48 ensureConfigIsEditable,
49 asyncMiddleware(deleteCustomConfig)
52 async function getConfig (req: express.Request, res: express.Response) {
53 const json = await ServerConfigManager.Instance.getServerConfig(req.ip)
58 function getAbout (req: express.Request, res: express.Response) {
59 const about: About = {
61 name: CONFIG.INSTANCE.NAME,
62 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
63 description: CONFIG.INSTANCE.DESCRIPTION,
64 terms: CONFIG.INSTANCE.TERMS,
65 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
67 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
69 creationReason: CONFIG.INSTANCE.CREATION_REASON,
70 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
71 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
72 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
73 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
75 languages: CONFIG.INSTANCE.LANGUAGES,
76 categories: CONFIG.INSTANCE.CATEGORIES
80 return res.json(about)
83 function getCustomConfig (req: express.Request, res: express.Response) {
84 const data = customConfig()
89 async function deleteCustomConfig (req: express.Request, res: express.Response) {
90 await remove(CONFIG.CUSTOM_FILE)
92 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
95 ClientHtml.invalidCache()
97 const data = customConfig()
102 async function updateCustomConfig (req: express.Request, res: express.Response) {
103 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
105 // camelCase to snake_case key + Force number conversion
106 const toUpdateJSON = convertCustomConfigBody(req.body)
108 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
111 ClientHtml.invalidCache()
113 const data = customConfig()
116 getAuditIdFromRes(res),
117 new CustomConfigAuditView(data),
118 oldCustomConfigAuditKeys
121 return res.json(data)
124 // ---------------------------------------------------------------------------
130 // ---------------------------------------------------------------------------
132 function customConfig (): CustomConfig {
135 name: CONFIG.INSTANCE.NAME,
136 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
137 description: CONFIG.INSTANCE.DESCRIPTION,
138 terms: CONFIG.INSTANCE.TERMS,
139 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
141 creationReason: CONFIG.INSTANCE.CREATION_REASON,
142 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
143 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
144 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
145 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
146 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
148 languages: CONFIG.INSTANCE.LANGUAGES,
149 categories: CONFIG.INSTANCE.CATEGORIES,
151 isNSFW: CONFIG.INSTANCE.IS_NSFW,
152 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
154 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
157 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
158 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
162 default: CONFIG.THEME.DEFAULT
166 username: CONFIG.SERVICES.TWITTER.USERNAME,
167 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
173 preferAuthorDisplayName: CONFIG.CLIENT.VIDEOS.MINIATURE.PREFER_AUTHOR_DISPLAY_NAME
178 redirectOnSingleExternalAuth: CONFIG.CLIENT.MENU.LOGIN.REDIRECT_ON_SINGLE_EXTERNAL_AUTH
184 size: CONFIG.CACHE.PREVIEWS.SIZE
187 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
190 size: CONFIG.CACHE.TORRENTS.SIZE
194 enabled: CONFIG.SIGNUP.ENABLED,
195 limit: CONFIG.SIGNUP.LIMIT,
196 requiresApproval: CONFIG.SIGNUP.REQUIRES_APPROVAL,
197 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION,
198 minimumAge: CONFIG.SIGNUP.MINIMUM_AGE
201 email: CONFIG.ADMIN.EMAIL
204 enabled: CONFIG.CONTACT_FORM.ENABLED
209 enabled: CONFIG.USER.HISTORY.VIDEOS.ENABLED
212 videoQuota: CONFIG.USER.VIDEO_QUOTA,
213 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
216 maxPerUser: CONFIG.VIDEO_CHANNELS.MAX_PER_USER
219 enabled: CONFIG.TRANSCODING.ENABLED,
221 enabled: CONFIG.TRANSCODING.REMOTE_RUNNERS.ENABLED
223 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
224 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
225 threads: CONFIG.TRANSCODING.THREADS,
226 concurrency: CONFIG.TRANSCODING.CONCURRENCY,
227 profile: CONFIG.TRANSCODING.PROFILE,
229 '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
230 '144p': CONFIG.TRANSCODING.RESOLUTIONS['144p'],
231 '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
232 '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
233 '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
234 '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
235 '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
236 '1440p': CONFIG.TRANSCODING.RESOLUTIONS['1440p'],
237 '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
239 alwaysTranscodeOriginalResolution: CONFIG.TRANSCODING.ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION,
241 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
244 enabled: CONFIG.TRANSCODING.HLS.ENABLED
248 enabled: CONFIG.LIVE.ENABLED,
249 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
251 enabled: CONFIG.LIVE.LATENCY_SETTING.ENABLED
253 maxDuration: CONFIG.LIVE.MAX_DURATION,
254 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
255 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
257 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
259 enabled: CONFIG.LIVE.TRANSCODING.REMOTE_RUNNERS.ENABLED
261 threads: CONFIG.LIVE.TRANSCODING.THREADS,
262 profile: CONFIG.LIVE.TRANSCODING.PROFILE,
264 '144p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['144p'],
265 '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],
266 '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],
267 '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],
268 '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],
269 '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],
270 '1440p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1440p'],
271 '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p']
273 alwaysTranscodeOriginalResolution: CONFIG.LIVE.TRANSCODING.ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION
277 enabled: CONFIG.VIDEO_STUDIO.ENABLED,
279 enabled: CONFIG.VIDEO_STUDIO.REMOTE_RUNNERS.ENABLED
284 concurrency: CONFIG.IMPORT.VIDEOS.CONCURRENCY,
286 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
289 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
292 videoChannelSynchronization: {
293 enabled: CONFIG.IMPORT.VIDEO_CHANNEL_SYNCHRONIZATION.ENABLED,
294 maxPerUser: CONFIG.IMPORT.VIDEO_CHANNEL_SYNCHRONIZATION.MAX_PER_USER
300 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
301 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
308 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
314 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
315 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
321 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
325 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
326 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
331 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
332 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
333 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
334 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
338 users: CONFIG.SEARCH.REMOTE_URI.USERS,
339 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
342 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
343 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
344 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
345 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
351 function convertCustomConfigBody (body: CustomConfig) {
352 function keyConverter (k: string) {
353 // Transcoding resolutions exception
354 if (/^\d{3,4}p$/.exec(k)) return k
355 if (k === '0p') return k
360 function valueConverter (v: any) {
361 if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
366 return objectConverter(body, keyConverter, valueConverter)