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'
13 import { logger } from '@server/helpers/logger'
15 const configRouter = express.Router()
17 const auditLogger = auditLoggerFactory('config')
20 openapiOperationDoc({ operationId: 'getConfig' }),
21 asyncMiddleware(getConfig)
24 configRouter.get('/about',
25 openapiOperationDoc({ operationId: 'getAbout' }),
29 configRouter.get('/custom',
30 openapiOperationDoc({ operationId: 'getCustomConfig' }),
32 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
36 configRouter.put('/custom',
37 openapiOperationDoc({ operationId: 'putCustomConfig' }),
39 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
40 ensureConfigIsEditable,
41 customConfigUpdateValidator,
42 asyncMiddleware(updateCustomConfig)
45 configRouter.delete('/custom',
46 openapiOperationDoc({ operationId: 'delCustomConfig' }),
48 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
49 ensureConfigIsEditable,
50 asyncMiddleware(deleteCustomConfig)
53 async function getConfig (req: express.Request, res: express.Response) {
54 const json = await ServerConfigManager.Instance.getServerConfig(req.ip)
59 function getAbout (req: express.Request, res: express.Response) {
60 const about: About = {
62 name: CONFIG.INSTANCE.NAME,
63 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
64 description: CONFIG.INSTANCE.DESCRIPTION,
65 terms: CONFIG.INSTANCE.TERMS,
66 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
68 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
70 creationReason: CONFIG.INSTANCE.CREATION_REASON,
71 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
72 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
73 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
74 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
76 languages: CONFIG.INSTANCE.LANGUAGES,
77 categories: CONFIG.INSTANCE.CATEGORIES
81 return res.json(about)
84 function getCustomConfig (req: express.Request, res: express.Response) {
85 const data = customConfig()
90 async function deleteCustomConfig (req: express.Request, res: express.Response) {
91 await remove(CONFIG.CUSTOM_FILE)
93 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
96 ClientHtml.invalidCache()
98 const data = customConfig()
100 return res.json(data)
103 async function updateCustomConfig (req: express.Request, res: express.Response) {
104 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
106 // camelCase to snake_case key + Force number conversion
107 const toUpdateJSON = convertCustomConfigBody(req.body)
109 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
112 ClientHtml.invalidCache()
114 const data = customConfig()
116 logger.info('coucou', { data })
118 getAuditIdFromRes(res),
119 new CustomConfigAuditView(data),
120 oldCustomConfigAuditKeys
123 return res.json(data)
126 // ---------------------------------------------------------------------------
132 // ---------------------------------------------------------------------------
134 function customConfig (): CustomConfig {
137 name: CONFIG.INSTANCE.NAME,
138 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
139 description: CONFIG.INSTANCE.DESCRIPTION,
140 terms: CONFIG.INSTANCE.TERMS,
141 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
143 creationReason: CONFIG.INSTANCE.CREATION_REASON,
144 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
145 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
146 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
147 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
148 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
150 languages: CONFIG.INSTANCE.LANGUAGES,
151 categories: CONFIG.INSTANCE.CATEGORIES,
153 isNSFW: CONFIG.INSTANCE.IS_NSFW,
154 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
156 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
159 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
160 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
164 default: CONFIG.THEME.DEFAULT
168 username: CONFIG.SERVICES.TWITTER.USERNAME,
169 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
175 preferAuthorDisplayName: CONFIG.CLIENT.VIDEOS.MINIATURE.PREFER_AUTHOR_DISPLAY_NAME
180 redirectOnSingleExternalAuth: CONFIG.CLIENT.MENU.LOGIN.REDIRECT_ON_SINGLE_EXTERNAL_AUTH
186 size: CONFIG.CACHE.PREVIEWS.SIZE
189 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
192 size: CONFIG.CACHE.TORRENTS.SIZE
196 enabled: CONFIG.SIGNUP.ENABLED,
197 limit: CONFIG.SIGNUP.LIMIT,
198 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION,
199 minimumAge: CONFIG.SIGNUP.MINIMUM_AGE
202 email: CONFIG.ADMIN.EMAIL
205 enabled: CONFIG.CONTACT_FORM.ENABLED
208 videoQuota: CONFIG.USER.VIDEO_QUOTA,
209 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
212 maxPerUser: CONFIG.VIDEO_CHANNELS.MAX_PER_USER
215 enabled: CONFIG.TRANSCODING.ENABLED,
216 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
217 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
218 threads: CONFIG.TRANSCODING.THREADS,
219 concurrency: CONFIG.TRANSCODING.CONCURRENCY,
220 profile: CONFIG.TRANSCODING.PROFILE,
222 '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
223 '144p': CONFIG.TRANSCODING.RESOLUTIONS['144p'],
224 '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
225 '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
226 '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
227 '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
228 '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
229 '1440p': CONFIG.TRANSCODING.RESOLUTIONS['1440p'],
230 '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
232 alwaysTranscodeOriginalResolution: CONFIG.TRANSCODING.ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION,
234 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
237 enabled: CONFIG.TRANSCODING.HLS.ENABLED
241 enabled: CONFIG.LIVE.ENABLED,
242 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
244 enabled: CONFIG.LIVE.LATENCY_SETTING.ENABLED
246 maxDuration: CONFIG.LIVE.MAX_DURATION,
247 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
248 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
250 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
251 threads: CONFIG.LIVE.TRANSCODING.THREADS,
252 profile: CONFIG.LIVE.TRANSCODING.PROFILE,
254 '144p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['144p'],
255 '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],
256 '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],
257 '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],
258 '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],
259 '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],
260 '1440p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1440p'],
261 '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p']
263 alwaysTranscodeOriginalResolution: CONFIG.LIVE.TRANSCODING.ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION
267 enabled: CONFIG.VIDEO_STUDIO.ENABLED
271 concurrency: CONFIG.IMPORT.VIDEOS.CONCURRENCY,
273 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
276 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
283 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
284 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
291 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
297 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
298 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
304 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
308 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
309 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
314 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
315 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
316 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
317 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
321 users: CONFIG.SEARCH.REMOTE_URI.USERS,
322 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
325 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
326 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
327 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
328 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
334 function convertCustomConfigBody (body: CustomConfig) {
335 function keyConverter (k: string) {
336 // Transcoding resolutions exception
337 if (/^\d{3,4}p$/.exec(k)) return k
338 if (k === '0p') return k
343 function valueConverter (v: any) {
344 if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
349 return objectConverter(body, keyConverter, valueConverter)