1 import { isSignupAllowed, isSignupAllowedForCurrentIP } from '@server/helpers/signup'
2 import { getServerCommit } from '@server/helpers/utils'
3 import { CONFIG, isEmailEnabled } from '@server/initializers/config'
4 import { CONSTRAINTS_FIELDS, DEFAULT_THEME_NAME, PEERTUBE_VERSION } from '@server/initializers/constants'
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)
46 name: CONFIG.INSTANCE.NAME,
47 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
48 isNSFW: CONFIG.INSTANCE.IS_NSFW,
49 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
50 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
52 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
53 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
58 users: CONFIG.SEARCH.REMOTE_URI.USERS,
59 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
62 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
63 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
64 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
65 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
69 registered: this.getRegisteredPlugins(),
70 registeredExternalAuths: this.getExternalAuthsPlugins(),
71 registeredIdAndPassAuths: this.getIdAndPassAuthPlugins()
74 registered: this.getRegisteredThemes(),
78 enabled: isEmailEnabled()
81 enabled: CONFIG.CONTACT_FORM.ENABLED
83 serverVersion: PEERTUBE_VERSION,
84 serverCommit: this.serverCommit,
87 enabled: CONFIG.TRANSCODING.HLS.ENABLED
90 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
92 enabledResolutions: this.getEnabledResolutions('vod'),
93 profile: CONFIG.TRANSCODING.PROFILE,
94 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('vod')
97 enabled: CONFIG.LIVE.ENABLED,
99 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
100 maxDuration: CONFIG.LIVE.MAX_DURATION,
101 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
102 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
105 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
106 enabledResolutions: this.getEnabledResolutions('live'),
107 profile: CONFIG.LIVE.TRANSCODING.PROFILE,
108 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('live')
112 port: CONFIG.LIVE.RTMP.PORT
118 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
121 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
128 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
135 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
137 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
143 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
145 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
150 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
152 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
156 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
162 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
164 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
168 videoQuota: CONFIG.USER.VIDEO_QUOTA,
169 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
173 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS,
175 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
176 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
181 enabled: CONFIG.TRACKER.ENABLED
187 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
193 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
194 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
195 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
196 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
200 enabled: this.homepageEnabled
205 async getServerConfig (ip?: string): Promise<ServerConfig> {
206 const { allowed } = await Hooks.wrapPromiseFun(
211 'filter:api.user.signup.allowed.result'
214 const allowedForCurrentIP = isSignupAllowedForCurrentIP(ip)
219 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
222 const htmlConfig = await this.getHTMLServerConfig()
224 return { ...htmlConfig, signup }
227 getRegisteredThemes () {
228 return PluginManager.Instance.getRegisteredThemes()
232 description: t.description,
234 clientScripts: t.clientScripts
238 getRegisteredPlugins () {
239 return PluginManager.Instance.getRegisteredPlugins()
243 description: p.description,
244 clientScripts: p.clientScripts
248 getEnabledResolutions (type: 'vod' | 'live') {
249 const transcoding = type === 'vod'
251 : CONFIG.LIVE.TRANSCODING
253 return Object.keys(transcoding.RESOLUTIONS)
254 .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true)
255 .map(r => parseInt(r, 10))
258 private getIdAndPassAuthPlugins () {
259 const result: RegisteredIdAndPassAuthConfig[] = []
261 for (const p of PluginManager.Instance.getIdAndPassAuths()) {
262 for (const auth of p.idAndPassAuths) {
267 authName: auth.authName,
268 weight: auth.getWeight()
276 private getExternalAuthsPlugins () {
277 const result: RegisteredExternalAuthConfig[] = []
279 for (const p of PluginManager.Instance.getExternalAuths()) {
280 for (const auth of p.externalAuths) {
285 authName: auth.authName,
286 authDisplayName: auth.authDisplayName()
294 static get Instance () {
295 return this.instance || (this.instance = new this())
299 // ---------------------------------------------------------------------------