1 import { getServerCommit } from '@server/helpers/utils'
2 import { CONFIG, isEmailEnabled } from '@server/initializers/config'
3 import { CONSTRAINTS_FIELDS, DEFAULT_THEME_NAME, PEERTUBE_VERSION } from '@server/initializers/constants'
4 import { isSignupAllowed, isSignupAllowedForCurrentIP } from '@server/lib/signup'
5 import { ActorCustomPageModel } from '@server/models/account/actor-custom-page'
6 import { HTMLServerConfig, RegisteredExternalAuthConfig, RegisteredIdAndPassAuthConfig, ServerConfig } from '@shared/models'
7 import { Hooks } from './plugins/hooks'
8 import { PluginManager } from './plugins/plugin-manager'
9 import { getThemeOrDefault } from './plugins/theme-utils'
10 import { VideoTranscodingProfilesManager } from './transcoding/video-transcoding-profiles'
14 * Used to send the server config to clients (using REST/API or plugins API)
15 * We need a singleton class to manage config state depending on external events (to build menu entries etc)
19 class ServerConfigManager {
21 private static instance: ServerConfigManager
23 private serverCommit: string
25 private homepageEnabled = false
27 private constructor () {}
30 const instanceHomepage = await ActorCustomPageModel.loadInstanceHomepage()
32 this.updateHomepageState(instanceHomepage?.content)
35 updateHomepageState (content: string) {
36 this.homepageEnabled = !!content
39 async getHTMLServerConfig (): Promise<HTMLServerConfig> {
40 if (this.serverCommit === undefined) this.serverCommit = await getServerCommit()
42 const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
48 preferAuthorDisplayName: CONFIG.CLIENT.VIDEOS.MINIATURE.PREFER_AUTHOR_DISPLAY_NAME
53 redirectOnSingleExternalAuth: CONFIG.CLIENT.MENU.LOGIN.REDIRECT_ON_SINGLE_EXTERNAL_AUTH
60 downloadEnabled: CONFIG.DEFAULTS.PUBLISH.DOWNLOAD_ENABLED,
61 commentsEnabled: CONFIG.DEFAULTS.PUBLISH.COMMENTS_ENABLED,
62 privacy: CONFIG.DEFAULTS.PUBLISH.PRIVACY,
63 licence: CONFIG.DEFAULTS.PUBLISH.LICENCE
70 allowed: CONFIG.WEBADMIN.CONFIGURATION.EDITION.ALLOWED
76 name: CONFIG.INSTANCE.NAME,
77 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
78 isNSFW: CONFIG.INSTANCE.IS_NSFW,
79 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
80 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
82 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
83 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
88 users: CONFIG.SEARCH.REMOTE_URI.USERS,
89 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
92 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
93 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
94 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
95 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
99 registered: this.getRegisteredPlugins(),
100 registeredExternalAuths: this.getExternalAuthsPlugins(),
101 registeredIdAndPassAuths: this.getIdAndPassAuthPlugins()
104 registered: this.getRegisteredThemes(),
105 default: defaultTheme
108 enabled: isEmailEnabled()
111 enabled: CONFIG.CONTACT_FORM.ENABLED
113 serverVersion: PEERTUBE_VERSION,
114 serverCommit: this.serverCommit,
117 enabled: CONFIG.TRANSCODING.HLS.ENABLED
120 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
122 enabledResolutions: this.getEnabledResolutions('vod'),
123 profile: CONFIG.TRANSCODING.PROFILE,
124 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('vod')
127 enabled: CONFIG.LIVE.ENABLED,
129 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
130 maxDuration: CONFIG.LIVE.MAX_DURATION,
131 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
132 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
135 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
136 enabledResolutions: this.getEnabledResolutions('live'),
137 profile: CONFIG.LIVE.TRANSCODING.PROFILE,
138 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('live')
142 port: CONFIG.LIVE.RTMP.PORT
148 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
151 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
158 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
165 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
167 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
173 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
175 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
180 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
182 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
186 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
192 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
194 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
198 videoQuota: CONFIG.USER.VIDEO_QUOTA,
199 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
202 maxPerUser: CONFIG.VIDEO_CHANNELS.MAX_PER_USER
206 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS,
208 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
209 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
214 enabled: CONFIG.TRACKER.ENABLED
220 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
226 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
227 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
228 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
229 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
233 enabled: this.homepageEnabled
238 async getServerConfig (ip?: string): Promise<ServerConfig> {
239 const { allowed } = await Hooks.wrapPromiseFun(
244 'filter:api.user.signup.allowed.result'
247 const allowedForCurrentIP = isSignupAllowedForCurrentIP(ip)
252 minimumAge: CONFIG.SIGNUP.MINIMUM_AGE,
253 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
256 const htmlConfig = await this.getHTMLServerConfig()
258 return { ...htmlConfig, signup }
261 getRegisteredThemes () {
262 return PluginManager.Instance.getRegisteredThemes()
266 description: t.description,
268 clientScripts: t.clientScripts
272 getRegisteredPlugins () {
273 return PluginManager.Instance.getRegisteredPlugins()
277 description: p.description,
278 clientScripts: p.clientScripts
282 getEnabledResolutions (type: 'vod' | 'live') {
283 const transcoding = type === 'vod'
285 : CONFIG.LIVE.TRANSCODING
287 return Object.keys(transcoding.RESOLUTIONS)
288 .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true)
289 .map(r => parseInt(r, 10))
292 private getIdAndPassAuthPlugins () {
293 const result: RegisteredIdAndPassAuthConfig[] = []
295 for (const p of PluginManager.Instance.getIdAndPassAuths()) {
296 for (const auth of p.idAndPassAuths) {
301 authName: auth.authName,
302 weight: auth.getWeight()
310 private getExternalAuthsPlugins () {
311 const result: RegisteredExternalAuthConfig[] = []
313 for (const p of PluginManager.Instance.getExternalAuths()) {
314 for (const auth of p.externalAuths) {
319 authName: auth.authName,
320 authDisplayName: auth.authDisplayName()
328 static get Instance () {
329 return this.instance || (this.instance = new this())
333 // ---------------------------------------------------------------------------