1 import * as express from 'express'
2 import { remove, writeJSON } from 'fs-extra'
3 import { snakeCase } from 'lodash'
4 import validator from 'validator'
5 import { getServerConfig } from '@server/lib/config'
6 import { 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 { CONFIG, reloadConfig } from '../../initializers/config'
12 import { ClientHtml } from '../../lib/client-html'
13 import { asyncMiddleware, authenticate, ensureUserHasRight } from '../../middlewares'
14 import { customConfigUpdateValidator } from '../../middlewares/validators/config'
16 const configRouter = express.Router()
18 const auditLogger = auditLoggerFactory('config')
20 configRouter.get('/about', getAbout)
22 asyncMiddleware(getConfig)
25 configRouter.get('/custom',
27 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
30 configRouter.put('/custom',
32 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
33 customConfigUpdateValidator,
34 asyncMiddleware(updateCustomConfig)
36 configRouter.delete('/custom',
38 ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
39 asyncMiddleware(deleteCustomConfig)
42 async function getConfig (req: express.Request, res: express.Response) {
43 const json = await getServerConfig(req.ip)
48 function getAbout (req: express.Request, res: express.Response) {
49 const about: About = {
51 name: CONFIG.INSTANCE.NAME,
52 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
53 description: CONFIG.INSTANCE.DESCRIPTION,
54 terms: CONFIG.INSTANCE.TERMS,
55 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
57 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
59 creationReason: CONFIG.INSTANCE.CREATION_REASON,
60 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
61 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
62 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
63 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
65 languages: CONFIG.INSTANCE.LANGUAGES,
66 categories: CONFIG.INSTANCE.CATEGORIES
70 return res.json(about).end()
73 function getCustomConfig (req: express.Request, res: express.Response) {
74 const data = customConfig()
76 return res.json(data).end()
79 async function deleteCustomConfig (req: express.Request, res: express.Response) {
80 await remove(CONFIG.CUSTOM_FILE)
82 auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))
85 ClientHtml.invalidCache()
87 const data = customConfig()
92 async function updateCustomConfig (req: express.Request, res: express.Response) {
93 const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())
95 // camelCase to snake_case key + Force number conversion
96 const toUpdateJSON = convertCustomConfigBody(req.body)
98 await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })
101 ClientHtml.invalidCache()
103 const data = customConfig()
106 getAuditIdFromRes(res),
107 new CustomConfigAuditView(data),
108 oldCustomConfigAuditKeys
111 return res.json(data)
114 // ---------------------------------------------------------------------------
120 // ---------------------------------------------------------------------------
122 function customConfig (): CustomConfig {
125 name: CONFIG.INSTANCE.NAME,
126 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
127 description: CONFIG.INSTANCE.DESCRIPTION,
128 terms: CONFIG.INSTANCE.TERMS,
129 codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
131 creationReason: CONFIG.INSTANCE.CREATION_REASON,
132 moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
133 administrator: CONFIG.INSTANCE.ADMINISTRATOR,
134 maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
135 businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
136 hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
138 languages: CONFIG.INSTANCE.LANGUAGES,
139 categories: CONFIG.INSTANCE.CATEGORIES,
141 isNSFW: CONFIG.INSTANCE.IS_NSFW,
142 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
144 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
147 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
148 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
152 default: CONFIG.THEME.DEFAULT
156 username: CONFIG.SERVICES.TWITTER.USERNAME,
157 whitelisted: CONFIG.SERVICES.TWITTER.WHITELISTED
162 size: CONFIG.CACHE.PREVIEWS.SIZE
165 size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE
168 size: CONFIG.CACHE.TORRENTS.SIZE
172 enabled: CONFIG.SIGNUP.ENABLED,
173 limit: CONFIG.SIGNUP.LIMIT,
174 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
177 email: CONFIG.ADMIN.EMAIL
180 enabled: CONFIG.CONTACT_FORM.ENABLED
183 videoQuota: CONFIG.USER.VIDEO_QUOTA,
184 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
187 enabled: CONFIG.TRANSCODING.ENABLED,
188 allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
189 allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
190 threads: CONFIG.TRANSCODING.THREADS,
191 concurrency: CONFIG.TRANSCODING.CONCURRENCY,
192 profile: CONFIG.TRANSCODING.PROFILE,
194 '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
195 '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
196 '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
197 '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
198 '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
199 '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
200 '1440p': CONFIG.TRANSCODING.RESOLUTIONS['1440p'],
201 '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
204 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
207 enabled: CONFIG.TRANSCODING.HLS.ENABLED
211 enabled: CONFIG.LIVE.ENABLED,
212 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
213 maxDuration: CONFIG.LIVE.MAX_DURATION,
214 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
215 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
217 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
218 threads: CONFIG.LIVE.TRANSCODING.THREADS,
219 profile: CONFIG.LIVE.TRANSCODING.PROFILE,
221 '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],
222 '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],
223 '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],
224 '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],
225 '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],
226 '1440p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1440p'],
227 '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p']
233 concurrency: CONFIG.IMPORT.VIDEOS.CONCURRENCY,
235 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
238 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
245 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
246 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
253 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
259 enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
260 manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
266 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
270 enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
271 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
276 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
277 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
278 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
279 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
283 users: CONFIG.SEARCH.REMOTE_URI.USERS,
284 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
287 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
288 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
289 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
290 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
296 function convertCustomConfigBody (body: CustomConfig) {
297 function keyConverter (k: string) {
298 // Transcoding resolutions exception
299 if (/^\d{3,4}p$/.exec(k)) return k
300 if (k === '0p') return k
305 function valueConverter (v: any) {
306 if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
311 return objectConverter(body, keyConverter, valueConverter)