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
56 allowed: CONFIG.WEBADMIN.CONFIGURATION.EDITION.ALLOWED
62 name: CONFIG.INSTANCE.NAME,
63 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
64 isNSFW: CONFIG.INSTANCE.IS_NSFW,
65 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
66 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
68 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
69 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
74 users: CONFIG.SEARCH.REMOTE_URI.USERS,
75 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
78 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
79 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
80 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
81 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
85 registered: this.getRegisteredPlugins(),
86 registeredExternalAuths: this.getExternalAuthsPlugins(),
87 registeredIdAndPassAuths: this.getIdAndPassAuthPlugins()
90 registered: this.getRegisteredThemes(),
94 enabled: isEmailEnabled()
97 enabled: CONFIG.CONTACT_FORM.ENABLED
99 serverVersion: PEERTUBE_VERSION,
100 serverCommit: this.serverCommit,
103 enabled: CONFIG.TRANSCODING.HLS.ENABLED
106 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
108 enabledResolutions: this.getEnabledResolutions('vod'),
109 profile: CONFIG.TRANSCODING.PROFILE,
110 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('vod')
113 enabled: CONFIG.LIVE.ENABLED,
115 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
116 maxDuration: CONFIG.LIVE.MAX_DURATION,
117 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
118 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
121 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
122 enabledResolutions: this.getEnabledResolutions('live'),
123 profile: CONFIG.LIVE.TRANSCODING.PROFILE,
124 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('live')
128 port: CONFIG.LIVE.RTMP.PORT
134 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
137 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
144 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
151 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
153 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
159 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
161 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
166 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
168 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
172 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
178 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
180 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
184 videoQuota: CONFIG.USER.VIDEO_QUOTA,
185 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
189 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS,
191 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
192 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
197 enabled: CONFIG.TRACKER.ENABLED
203 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
209 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
210 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
211 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
212 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
216 enabled: this.homepageEnabled
221 async getServerConfig (ip?: string): Promise<ServerConfig> {
222 const { allowed } = await Hooks.wrapPromiseFun(
227 'filter:api.user.signup.allowed.result'
230 const allowedForCurrentIP = isSignupAllowedForCurrentIP(ip)
235 minimumAge: CONFIG.SIGNUP.MINIMUM_AGE,
236 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
239 const htmlConfig = await this.getHTMLServerConfig()
241 return { ...htmlConfig, signup }
244 getRegisteredThemes () {
245 return PluginManager.Instance.getRegisteredThemes()
249 description: t.description,
251 clientScripts: t.clientScripts
255 getRegisteredPlugins () {
256 return PluginManager.Instance.getRegisteredPlugins()
260 description: p.description,
261 clientScripts: p.clientScripts
265 getEnabledResolutions (type: 'vod' | 'live') {
266 const transcoding = type === 'vod'
268 : CONFIG.LIVE.TRANSCODING
270 return Object.keys(transcoding.RESOLUTIONS)
271 .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true)
272 .map(r => parseInt(r, 10))
275 private getIdAndPassAuthPlugins () {
276 const result: RegisteredIdAndPassAuthConfig[] = []
278 for (const p of PluginManager.Instance.getIdAndPassAuths()) {
279 for (const auth of p.idAndPassAuths) {
284 authName: auth.authName,
285 weight: auth.getWeight()
293 private getExternalAuthsPlugins () {
294 const result: RegisteredExternalAuthConfig[] = []
296 for (const p of PluginManager.Instance.getExternalAuths()) {
297 for (const auth of p.externalAuths) {
302 authName: auth.authName,
303 authDisplayName: auth.authDisplayName()
311 static get Instance () {
312 return this.instance || (this.instance = new this())
316 // ---------------------------------------------------------------------------