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)
45 allowEdits: CONFIG.WEBADMIN.CONFIGURATION.EDITS.ALLOWED,
49 showAuthorDisplayName: CONFIG.CLIENT.VIDEOS.MINIATURE.SHOW_AUTHOR_DISPLAY_NAME
54 name: CONFIG.INSTANCE.NAME,
55 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
56 isNSFW: CONFIG.INSTANCE.IS_NSFW,
57 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
58 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
60 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
61 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
66 users: CONFIG.SEARCH.REMOTE_URI.USERS,
67 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
70 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
71 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
72 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
73 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
77 registered: this.getRegisteredPlugins(),
78 registeredExternalAuths: this.getExternalAuthsPlugins(),
79 registeredIdAndPassAuths: this.getIdAndPassAuthPlugins()
82 registered: this.getRegisteredThemes(),
86 enabled: isEmailEnabled()
89 enabled: CONFIG.CONTACT_FORM.ENABLED
91 serverVersion: PEERTUBE_VERSION,
92 serverCommit: this.serverCommit,
95 enabled: CONFIG.TRANSCODING.HLS.ENABLED
98 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
100 enabledResolutions: this.getEnabledResolutions('vod'),
101 profile: CONFIG.TRANSCODING.PROFILE,
102 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('vod')
105 enabled: CONFIG.LIVE.ENABLED,
107 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
108 maxDuration: CONFIG.LIVE.MAX_DURATION,
109 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
110 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
113 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
114 enabledResolutions: this.getEnabledResolutions('live'),
115 profile: CONFIG.LIVE.TRANSCODING.PROFILE,
116 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('live')
120 port: CONFIG.LIVE.RTMP.PORT
126 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
129 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
136 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
143 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
145 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
151 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
153 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
158 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
160 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
164 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
170 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
172 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
176 videoQuota: CONFIG.USER.VIDEO_QUOTA,
177 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
181 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS,
183 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
184 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
189 enabled: CONFIG.TRACKER.ENABLED
195 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
201 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
202 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
203 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
204 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
208 enabled: this.homepageEnabled
213 async getServerConfig (ip?: string): Promise<ServerConfig> {
214 const { allowed } = await Hooks.wrapPromiseFun(
219 'filter:api.user.signup.allowed.result'
222 const allowedForCurrentIP = isSignupAllowedForCurrentIP(ip)
227 minimumAge: CONFIG.SIGNUP.MINIMUM_AGE,
228 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
231 const htmlConfig = await this.getHTMLServerConfig()
233 return { ...htmlConfig, signup }
236 getRegisteredThemes () {
237 return PluginManager.Instance.getRegisteredThemes()
241 description: t.description,
243 clientScripts: t.clientScripts
247 getRegisteredPlugins () {
248 return PluginManager.Instance.getRegisteredPlugins()
252 description: p.description,
253 clientScripts: p.clientScripts
257 getEnabledResolutions (type: 'vod' | 'live') {
258 const transcoding = type === 'vod'
260 : CONFIG.LIVE.TRANSCODING
262 return Object.keys(transcoding.RESOLUTIONS)
263 .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true)
264 .map(r => parseInt(r, 10))
267 private getIdAndPassAuthPlugins () {
268 const result: RegisteredIdAndPassAuthConfig[] = []
270 for (const p of PluginManager.Instance.getIdAndPassAuths()) {
271 for (const auth of p.idAndPassAuths) {
276 authName: auth.authName,
277 weight: auth.getWeight()
285 private getExternalAuthsPlugins () {
286 const result: RegisteredExternalAuthConfig[] = []
288 for (const p of PluginManager.Instance.getExternalAuths()) {
289 for (const auth of p.externalAuths) {
294 authName: auth.authName,
295 authDisplayName: auth.authDisplayName()
303 static get Instance () {
304 return this.instance || (this.instance = new this())
308 // ---------------------------------------------------------------------------