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
61 allowed: CONFIG.WEBADMIN.CONFIGURATION.EDITION.ALLOWED
67 name: CONFIG.INSTANCE.NAME,
68 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
69 isNSFW: CONFIG.INSTANCE.IS_NSFW,
70 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
71 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
73 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
74 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
79 users: CONFIG.SEARCH.REMOTE_URI.USERS,
80 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
83 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
84 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
85 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
86 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
90 registered: this.getRegisteredPlugins(),
91 registeredExternalAuths: this.getExternalAuthsPlugins(),
92 registeredIdAndPassAuths: this.getIdAndPassAuthPlugins()
95 registered: this.getRegisteredThemes(),
99 enabled: isEmailEnabled()
102 enabled: CONFIG.CONTACT_FORM.ENABLED
104 serverVersion: PEERTUBE_VERSION,
105 serverCommit: this.serverCommit,
108 enabled: CONFIG.TRANSCODING.HLS.ENABLED
111 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
113 enabledResolutions: this.getEnabledResolutions('vod'),
114 profile: CONFIG.TRANSCODING.PROFILE,
115 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('vod')
118 enabled: CONFIG.LIVE.ENABLED,
120 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
121 maxDuration: CONFIG.LIVE.MAX_DURATION,
122 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
123 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
126 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
127 enabledResolutions: this.getEnabledResolutions('live'),
128 profile: CONFIG.LIVE.TRANSCODING.PROFILE,
129 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('live')
133 port: CONFIG.LIVE.RTMP.PORT
139 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
142 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
149 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
156 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
158 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
164 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
166 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
171 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
173 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
177 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
183 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
185 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
189 videoQuota: CONFIG.USER.VIDEO_QUOTA,
190 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
193 maxPerUser: CONFIG.VIDEO_CHANNELS.MAX_PER_USER
197 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS,
199 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
200 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
205 enabled: CONFIG.TRACKER.ENABLED
211 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
217 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
218 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
219 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
220 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
224 enabled: this.homepageEnabled
229 async getServerConfig (ip?: string): Promise<ServerConfig> {
230 const { allowed } = await Hooks.wrapPromiseFun(
235 'filter:api.user.signup.allowed.result'
238 const allowedForCurrentIP = isSignupAllowedForCurrentIP(ip)
243 minimumAge: CONFIG.SIGNUP.MINIMUM_AGE,
244 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
247 const htmlConfig = await this.getHTMLServerConfig()
249 return { ...htmlConfig, signup }
252 getRegisteredThemes () {
253 return PluginManager.Instance.getRegisteredThemes()
257 description: t.description,
259 clientScripts: t.clientScripts
263 getRegisteredPlugins () {
264 return PluginManager.Instance.getRegisteredPlugins()
268 description: p.description,
269 clientScripts: p.clientScripts
273 getEnabledResolutions (type: 'vod' | 'live') {
274 const transcoding = type === 'vod'
276 : CONFIG.LIVE.TRANSCODING
278 return Object.keys(transcoding.RESOLUTIONS)
279 .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true)
280 .map(r => parseInt(r, 10))
283 private getIdAndPassAuthPlugins () {
284 const result: RegisteredIdAndPassAuthConfig[] = []
286 for (const p of PluginManager.Instance.getIdAndPassAuths()) {
287 for (const auth of p.idAndPassAuths) {
292 authName: auth.authName,
293 weight: auth.getWeight()
301 private getExternalAuthsPlugins () {
302 const result: RegisteredExternalAuthConfig[] = []
304 for (const p of PluginManager.Instance.getExternalAuths()) {
305 for (const auth of p.externalAuths) {
310 authName: auth.authName,
311 authDisplayName: auth.authDisplayName()
319 static get Instance () {
320 return this.instance || (this.instance = new this())
324 // ---------------------------------------------------------------------------