+import { Hooks } from '@server/lib/plugins/hooks'
import * as express from 'express'
+import { remove, writeJSON } from 'fs-extra'
import { snakeCase } from 'lodash'
-import { ServerConfig, UserRight } from '../../../shared'
+import validator from 'validator'
+import { RegisteredExternalAuthConfig, RegisteredIdAndPassAuthConfig, ServerConfig, UserRight } from '../../../shared'
import { About } from '../../../shared/models/server/about.model'
import { CustomConfig } from '../../../shared/models/server/custom-config.model'
+import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger'
+import { objectConverter } from '../../helpers/core-utils'
import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/signup'
-import { CONFIG, CONSTRAINTS_FIELDS, reloadConfig } from '../../initializers'
+import { getServerCommit } from '../../helpers/utils'
+import { getEnabledResolutions } from '../../lib/video-transcoding'
+import { CONFIG, isEmailEnabled, reloadConfig } from '../../initializers/config'
+import { CONSTRAINTS_FIELDS, DEFAULT_THEME_NAME, PEERTUBE_VERSION } from '../../initializers/constants'
+import { ClientHtml } from '../../lib/client-html'
+import { PluginManager } from '../../lib/plugins/plugin-manager'
+import { getThemeOrDefault } from '../../lib/plugins/theme-utils'
import { asyncMiddleware, authenticate, ensureUserHasRight } from '../../middlewares'
import { customConfigUpdateValidator } from '../../middlewares/validators/config'
-import { ClientHtml } from '../../lib/client-html'
-import { auditLoggerFactory, CustomConfigAuditView, getAuditIdFromRes } from '../../helpers/audit-logger'
-import { remove, writeJSON } from 'fs-extra'
-import { getServerCommit } from '../../helpers/utils'
-import { Emailer } from '../../lib/emailer'
-import { isNumeric } from 'validator'
-import { objectConverter } from '../../helpers/core-utils'
+import { VideoTranscodingProfilesManager } from '@server/lib/video-transcoding-profiles'
-const packageJSON = require('../../../../package.json')
const configRouter = express.Router()
const auditLogger = auditLoggerFactory('config')
configRouter.get('/custom',
authenticate,
ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
- asyncMiddleware(getCustomConfig)
+ getCustomConfig
)
configRouter.put('/custom',
authenticate,
ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),
- asyncMiddleware(customConfigUpdateValidator),
+ customConfigUpdateValidator,
asyncMiddleware(updateCustomConfig)
)
configRouter.delete('/custom',
)
let serverCommit: string
+
async function getConfig (req: express.Request, res: express.Response) {
- const allowed = await isSignupAllowed()
+ const { allowed } = await Hooks.wrapPromiseFun(
+ isSignupAllowed,
+ {
+ ip: req.ip
+ },
+ 'filter:api.user.signup.allowed.result'
+ )
+
const allowedForCurrentIP = isSignupAllowedForCurrentIP(req.ip)
+ const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
if (serverCommit === undefined) serverCommit = await getServerCommit()
- const enabledResolutions = Object.keys(CONFIG.TRANSCODING.RESOLUTIONS)
- .filter(key => CONFIG.TRANSCODING.ENABLED === CONFIG.TRANSCODING.RESOLUTIONS[key] === true)
- .map(r => parseInt(r, 10))
-
const json: ServerConfig = {
instance: {
name: CONFIG.INSTANCE.NAME,
shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
- defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
isNSFW: CONFIG.INSTANCE.IS_NSFW,
defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
+ defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
customizations: {
javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
}
},
+ search: {
+ remoteUri: {
+ users: CONFIG.SEARCH.REMOTE_URI.USERS,
+ anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
+ },
+ searchIndex: {
+ enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
+ url: CONFIG.SEARCH.SEARCH_INDEX.URL,
+ disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
+ isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
+ }
+ },
+ plugin: {
+ registered: getRegisteredPlugins(),
+ registeredExternalAuths: getExternalAuthsPlugins(),
+ registeredIdAndPassAuths: getIdAndPassAuthPlugins()
+ },
+ theme: {
+ registered: getRegisteredThemes(),
+ default: defaultTheme
+ },
email: {
- enabled: Emailer.isEnabled()
+ enabled: isEmailEnabled()
},
contactForm: {
enabled: CONFIG.CONTACT_FORM.ENABLED
},
- serverVersion: packageJSON.version,
+ serverVersion: PEERTUBE_VERSION,
serverCommit,
signup: {
allowed,
hls: {
enabled: CONFIG.TRANSCODING.HLS.ENABLED
},
- enabledResolutions
+ webtorrent: {
+ enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
+ },
+ enabledResolutions: getEnabledResolutions('vod'),
+ profile: CONFIG.TRANSCODING.PROFILE,
+ availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('vod')
+ },
+ live: {
+ enabled: CONFIG.LIVE.ENABLED,
+
+ allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
+ maxDuration: CONFIG.LIVE.MAX_DURATION,
+ maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
+ maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
+
+ transcoding: {
+ enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
+ enabledResolutions: getEnabledResolutions('live'),
+ profile: CONFIG.LIVE.TRANSCODING.PROFILE,
+ availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('live')
+ },
+
+ rtmp: {
+ port: CONFIG.LIVE.RTMP.PORT
+ }
},
import: {
videos: {
},
trending: {
videos: {
- intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
+ intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS,
+ algorithms: {
+ enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
+ default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
+ }
}
+ },
+ tracker: {
+ enabled: CONFIG.TRACKER.ENABLED
+ },
+
+ followings: {
+ instance: {
+ autoFollowIndex: {
+ indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
+ }
+ }
+ },
+
+ broadcastMessage: {
+ enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
+ message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
+ level: CONFIG.BROADCAST_MESSAGE.LEVEL,
+ dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
}
}
name: CONFIG.INSTANCE.NAME,
shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
description: CONFIG.INSTANCE.DESCRIPTION,
- terms: CONFIG.INSTANCE.TERMS
+ terms: CONFIG.INSTANCE.TERMS,
+ codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
+
+ hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
+
+ creationReason: CONFIG.INSTANCE.CREATION_REASON,
+ moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
+ administrator: CONFIG.INSTANCE.ADMINISTRATOR,
+ maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
+ businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
+
+ languages: CONFIG.INSTANCE.LANGUAGES,
+ categories: CONFIG.INSTANCE.CATEGORIES
}
}
return res.json(about).end()
}
-async function getCustomConfig (req: express.Request, res: express.Response) {
+function getCustomConfig (req: express.Request, res: express.Response) {
const data = customConfig()
return res.json(data).end()
const data = customConfig()
- return res.json(data).end()
+ return res.json(data)
}
async function updateCustomConfig (req: express.Request, res: express.Response) {
oldCustomConfigAuditKeys
)
- return res.json(data).end()
+ return res.json(data)
+}
+
+function getRegisteredThemes () {
+ return PluginManager.Instance.getRegisteredThemes()
+ .map(t => ({
+ name: t.name,
+ version: t.version,
+ description: t.description,
+ css: t.css,
+ clientScripts: t.clientScripts
+ }))
+}
+
+function getRegisteredPlugins () {
+ return PluginManager.Instance.getRegisteredPlugins()
+ .map(p => ({
+ name: p.name,
+ version: p.version,
+ description: p.description,
+ clientScripts: p.clientScripts
+ }))
+}
+
+function getIdAndPassAuthPlugins () {
+ const result: RegisteredIdAndPassAuthConfig[] = []
+
+ for (const p of PluginManager.Instance.getIdAndPassAuths()) {
+ for (const auth of p.idAndPassAuths) {
+ result.push({
+ npmName: p.npmName,
+ name: p.name,
+ version: p.version,
+ authName: auth.authName,
+ weight: auth.getWeight()
+ })
+ }
+ }
+
+ return result
+}
+
+function getExternalAuthsPlugins () {
+ const result: RegisteredExternalAuthConfig[] = []
+
+ for (const p of PluginManager.Instance.getExternalAuths()) {
+ for (const auth of p.externalAuths) {
+ result.push({
+ npmName: p.npmName,
+ name: p.name,
+ version: p.version,
+ authName: auth.authName,
+ authDisplayName: auth.authDisplayName()
+ })
+ }
+ }
+
+ return result
}
// ---------------------------------------------------------------------------
export {
- configRouter
+ configRouter,
+ getRegisteredPlugins,
+ getRegisteredThemes
}
// ---------------------------------------------------------------------------
shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
description: CONFIG.INSTANCE.DESCRIPTION,
terms: CONFIG.INSTANCE.TERMS,
+ codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,
+
+ creationReason: CONFIG.INSTANCE.CREATION_REASON,
+ moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,
+ administrator: CONFIG.INSTANCE.ADMINISTRATOR,
+ maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,
+ businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,
+ hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,
+
+ languages: CONFIG.INSTANCE.LANGUAGES,
+ categories: CONFIG.INSTANCE.CATEGORIES,
+
isNSFW: CONFIG.INSTANCE.IS_NSFW,
- defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
+
+ defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
+
customizations: {
css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,
javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT
}
},
+ theme: {
+ default: CONFIG.THEME.DEFAULT
+ },
services: {
twitter: {
username: CONFIG.SERVICES.TWITTER.USERNAME,
transcoding: {
enabled: CONFIG.TRANSCODING.ENABLED,
allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,
+ allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,
threads: CONFIG.TRANSCODING.THREADS,
+ profile: CONFIG.TRANSCODING.PROFILE,
resolutions: {
- '240p': CONFIG.TRANSCODING.RESOLUTIONS[ '240p' ],
- '360p': CONFIG.TRANSCODING.RESOLUTIONS[ '360p' ],
- '480p': CONFIG.TRANSCODING.RESOLUTIONS[ '480p' ],
- '720p': CONFIG.TRANSCODING.RESOLUTIONS[ '720p' ],
- '1080p': CONFIG.TRANSCODING.RESOLUTIONS[ '1080p' ]
+ '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],
+ '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],
+ '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],
+ '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],
+ '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],
+ '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],
+ '1440p': CONFIG.TRANSCODING.RESOLUTIONS['1440p'],
+ '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']
+ },
+ webtorrent: {
+ enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
},
hls: {
enabled: CONFIG.TRANSCODING.HLS.ENABLED
}
},
+ live: {
+ enabled: CONFIG.LIVE.ENABLED,
+ allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
+ maxDuration: CONFIG.LIVE.MAX_DURATION,
+ maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
+ maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
+ transcoding: {
+ enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
+ threads: CONFIG.LIVE.TRANSCODING.THREADS,
+ profile: CONFIG.LIVE.TRANSCODING.PROFILE,
+ resolutions: {
+ '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],
+ '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],
+ '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],
+ '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],
+ '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],
+ '1440p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1440p'],
+ '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p']
+ }
+ }
+ },
import: {
videos: {
http: {
}
}
},
+ trending: {
+ videos: {
+ algorithms: {
+ enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
+ default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
+ }
+ }
+ },
autoBlacklist: {
videos: {
ofUsers: {
},
followers: {
instance: {
- enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED
+ enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,
+ manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL
+ }
+ },
+ followings: {
+ instance: {
+ autoFollowBack: {
+ enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED
+ },
+
+ autoFollowIndex: {
+ enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,
+ indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
+ }
+ }
+ },
+ broadcastMessage: {
+ enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
+ message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
+ level: CONFIG.BROADCAST_MESSAGE.LEVEL,
+ dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
+ },
+ search: {
+ remoteUri: {
+ users: CONFIG.SEARCH.REMOTE_URI.USERS,
+ anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
+ },
+ searchIndex: {
+ enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
+ url: CONFIG.SEARCH.SEARCH_INDEX.URL,
+ disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
+ isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
}
}
}
function keyConverter (k: string) {
// Transcoding resolutions exception
if (/^\d{3,4}p$/.exec(k)) return k
+ if (k === '0p') return k
return snakeCase(k)
}
function valueConverter (v: any) {
- if (isNumeric(v + '')) return parseInt('' + v, 10)
+ if (validator.isNumeric(v + '')) return parseInt('' + v, 10)
return v
}