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
67 enabled: CONFIG.DEFAULTS.P2P.WEBAPP.ENABLED
70 enabled: CONFIG.DEFAULTS.P2P.EMBED.ENABLED
78 allowed: CONFIG.WEBADMIN.CONFIGURATION.EDITION.ALLOWED
84 name: CONFIG.INSTANCE.NAME,
85 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
86 isNSFW: CONFIG.INSTANCE.IS_NSFW,
87 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
88 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
90 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
91 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
96 users: CONFIG.SEARCH.REMOTE_URI.USERS,
97 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
100 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
101 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
102 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
103 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
107 registered: this.getRegisteredPlugins(),
108 registeredExternalAuths: this.getExternalAuthsPlugins(),
109 registeredIdAndPassAuths: this.getIdAndPassAuthPlugins()
112 registered: this.getRegisteredThemes(),
113 default: defaultTheme
116 enabled: isEmailEnabled()
119 enabled: CONFIG.CONTACT_FORM.ENABLED
121 serverVersion: PEERTUBE_VERSION,
122 serverCommit: this.serverCommit,
125 enabled: CONFIG.TRANSCODING.HLS.ENABLED
128 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
130 enabledResolutions: this.getEnabledResolutions('vod'),
131 profile: CONFIG.TRANSCODING.PROFILE,
132 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('vod')
135 enabled: CONFIG.LIVE.ENABLED,
137 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
138 maxDuration: CONFIG.LIVE.MAX_DURATION,
139 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
140 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
143 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
144 enabledResolutions: this.getEnabledResolutions('live'),
145 profile: CONFIG.LIVE.TRANSCODING.PROFILE,
146 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('live')
150 port: CONFIG.LIVE.RTMP.PORT
156 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
159 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
166 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
173 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
175 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
181 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
183 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
188 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
190 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
194 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
200 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
202 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
206 videoQuota: CONFIG.USER.VIDEO_QUOTA,
207 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
210 maxPerUser: CONFIG.VIDEO_CHANNELS.MAX_PER_USER
214 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS,
216 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
217 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
222 enabled: CONFIG.TRACKER.ENABLED
228 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
234 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
235 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
236 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
237 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
241 enabled: this.homepageEnabled
246 async getServerConfig (ip?: string): Promise<ServerConfig> {
247 const { allowed } = await Hooks.wrapPromiseFun(
252 'filter:api.user.signup.allowed.result'
255 const allowedForCurrentIP = isSignupAllowedForCurrentIP(ip)
260 minimumAge: CONFIG.SIGNUP.MINIMUM_AGE,
261 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
264 const htmlConfig = await this.getHTMLServerConfig()
266 return { ...htmlConfig, signup }
269 getRegisteredThemes () {
270 return PluginManager.Instance.getRegisteredThemes()
274 description: t.description,
276 clientScripts: t.clientScripts
280 getRegisteredPlugins () {
281 return PluginManager.Instance.getRegisteredPlugins()
285 description: p.description,
286 clientScripts: p.clientScripts
290 getEnabledResolutions (type: 'vod' | 'live') {
291 const transcoding = type === 'vod'
293 : CONFIG.LIVE.TRANSCODING
295 return Object.keys(transcoding.RESOLUTIONS)
296 .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true)
297 .map(r => parseInt(r, 10))
300 private getIdAndPassAuthPlugins () {
301 const result: RegisteredIdAndPassAuthConfig[] = []
303 for (const p of PluginManager.Instance.getIdAndPassAuths()) {
304 for (const auth of p.idAndPassAuths) {
309 authName: auth.authName,
310 weight: auth.getWeight()
318 private getExternalAuthsPlugins () {
319 const result: RegisteredExternalAuthConfig[] = []
321 for (const p of PluginManager.Instance.getExternalAuths()) {
322 for (const auth of p.externalAuths) {
327 authName: auth.authName,
328 authDisplayName: auth.authDisplayName()
336 static get Instance () {
337 return this.instance || (this.instance = new this())
341 // ---------------------------------------------------------------------------