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,
47 name: CONFIG.INSTANCE.NAME,
48 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
49 isNSFW: CONFIG.INSTANCE.IS_NSFW,
50 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
51 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
53 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
54 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
59 users: CONFIG.SEARCH.REMOTE_URI.USERS,
60 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
63 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
64 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
65 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
66 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
70 registered: this.getRegisteredPlugins(),
71 registeredExternalAuths: this.getExternalAuthsPlugins(),
72 registeredIdAndPassAuths: this.getIdAndPassAuthPlugins()
75 registered: this.getRegisteredThemes(),
79 enabled: isEmailEnabled()
82 enabled: CONFIG.CONTACT_FORM.ENABLED
84 serverVersion: PEERTUBE_VERSION,
85 serverCommit: this.serverCommit,
88 enabled: CONFIG.TRANSCODING.HLS.ENABLED
91 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
93 enabledResolutions: this.getEnabledResolutions('vod'),
94 profile: CONFIG.TRANSCODING.PROFILE,
95 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('vod')
98 enabled: CONFIG.LIVE.ENABLED,
100 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
101 maxDuration: CONFIG.LIVE.MAX_DURATION,
102 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
103 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
106 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
107 enabledResolutions: this.getEnabledResolutions('live'),
108 profile: CONFIG.LIVE.TRANSCODING.PROFILE,
109 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('live')
113 port: CONFIG.LIVE.RTMP.PORT
119 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
122 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
129 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
136 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
138 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
144 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
146 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
151 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
153 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
157 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
163 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
165 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
169 videoQuota: CONFIG.USER.VIDEO_QUOTA,
170 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
174 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS,
176 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
177 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
182 enabled: CONFIG.TRACKER.ENABLED
188 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
194 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
195 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
196 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
197 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
201 enabled: this.homepageEnabled
206 async getServerConfig (ip?: string): Promise<ServerConfig> {
207 const { allowed } = await Hooks.wrapPromiseFun(
212 'filter:api.user.signup.allowed.result'
215 const allowedForCurrentIP = isSignupAllowedForCurrentIP(ip)
220 minimumAge: CONFIG.SIGNUP.MINIMUM_AGE,
221 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
224 const htmlConfig = await this.getHTMLServerConfig()
226 return { ...htmlConfig, signup }
229 getRegisteredThemes () {
230 return PluginManager.Instance.getRegisteredThemes()
234 description: t.description,
236 clientScripts: t.clientScripts
240 getRegisteredPlugins () {
241 return PluginManager.Instance.getRegisteredPlugins()
245 description: p.description,
246 clientScripts: p.clientScripts
250 getEnabledResolutions (type: 'vod' | 'live') {
251 const transcoding = type === 'vod'
253 : CONFIG.LIVE.TRANSCODING
255 return Object.keys(transcoding.RESOLUTIONS)
256 .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true)
257 .map(r => parseInt(r, 10))
260 private getIdAndPassAuthPlugins () {
261 const result: RegisteredIdAndPassAuthConfig[] = []
263 for (const p of PluginManager.Instance.getIdAndPassAuths()) {
264 for (const auth of p.idAndPassAuths) {
269 authName: auth.authName,
270 weight: auth.getWeight()
278 private getExternalAuthsPlugins () {
279 const result: RegisteredExternalAuthConfig[] = []
281 for (const p of PluginManager.Instance.getExternalAuths()) {
282 for (const auth of p.externalAuths) {
287 authName: auth.authName,
288 authDisplayName: auth.authDisplayName()
296 static get Instance () {
297 return this.instance || (this.instance = new this())
301 // ---------------------------------------------------------------------------