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
60 downloadEnabled: CONFIG.DEFAULTS.PUBLISH.DOWNLOAD_ENABLED,
61 commentsEnabled: CONFIG.DEFAULTS.PUBLISH.COMMENTS_ENABLED,
62 privacy: CONFIG.DEFAULTS.PUBLISH.PRIVACY,
63 licence: CONFIG.DEFAULTS.PUBLISH.LICENCE
66 enabled: CONFIG.DEFAULTS.P2P.ENABLED
73 allowed: CONFIG.WEBADMIN.CONFIGURATION.EDITION.ALLOWED
79 name: CONFIG.INSTANCE.NAME,
80 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
81 isNSFW: CONFIG.INSTANCE.IS_NSFW,
82 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
83 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
85 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
86 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
91 users: CONFIG.SEARCH.REMOTE_URI.USERS,
92 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
95 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
96 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
97 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
98 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
102 registered: this.getRegisteredPlugins(),
103 registeredExternalAuths: this.getExternalAuthsPlugins(),
104 registeredIdAndPassAuths: this.getIdAndPassAuthPlugins()
107 registered: this.getRegisteredThemes(),
108 default: defaultTheme
111 enabled: isEmailEnabled()
114 enabled: CONFIG.CONTACT_FORM.ENABLED
116 serverVersion: PEERTUBE_VERSION,
117 serverCommit: this.serverCommit,
120 enabled: CONFIG.TRANSCODING.HLS.ENABLED
123 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
125 enabledResolutions: this.getEnabledResolutions('vod'),
126 profile: CONFIG.TRANSCODING.PROFILE,
127 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('vod')
130 enabled: CONFIG.LIVE.ENABLED,
132 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
133 maxDuration: CONFIG.LIVE.MAX_DURATION,
134 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
135 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
138 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
139 enabledResolutions: this.getEnabledResolutions('live'),
140 profile: CONFIG.LIVE.TRANSCODING.PROFILE,
141 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('live')
145 port: CONFIG.LIVE.RTMP.PORT
151 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
154 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
161 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
168 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
170 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
176 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
178 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
183 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
185 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
189 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
195 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
197 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
201 videoQuota: CONFIG.USER.VIDEO_QUOTA,
202 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
205 maxPerUser: CONFIG.VIDEO_CHANNELS.MAX_PER_USER
209 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS,
211 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
212 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
217 enabled: CONFIG.TRACKER.ENABLED
223 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
229 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
230 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
231 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
232 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
236 enabled: this.homepageEnabled
241 async getServerConfig (ip?: string): Promise<ServerConfig> {
242 const { allowed } = await Hooks.wrapPromiseFun(
247 'filter:api.user.signup.allowed.result'
250 const allowedForCurrentIP = isSignupAllowedForCurrentIP(ip)
255 minimumAge: CONFIG.SIGNUP.MINIMUM_AGE,
256 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
259 const htmlConfig = await this.getHTMLServerConfig()
261 return { ...htmlConfig, signup }
264 getRegisteredThemes () {
265 return PluginManager.Instance.getRegisteredThemes()
269 description: t.description,
271 clientScripts: t.clientScripts
275 getRegisteredPlugins () {
276 return PluginManager.Instance.getRegisteredPlugins()
280 description: p.description,
281 clientScripts: p.clientScripts
285 getEnabledResolutions (type: 'vod' | 'live') {
286 const transcoding = type === 'vod'
288 : CONFIG.LIVE.TRANSCODING
290 return Object.keys(transcoding.RESOLUTIONS)
291 .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true)
292 .map(r => parseInt(r, 10))
295 private getIdAndPassAuthPlugins () {
296 const result: RegisteredIdAndPassAuthConfig[] = []
298 for (const p of PluginManager.Instance.getIdAndPassAuths()) {
299 for (const auth of p.idAndPassAuths) {
304 authName: auth.authName,
305 weight: auth.getWeight()
313 private getExternalAuthsPlugins () {
314 const result: RegisteredExternalAuthConfig[] = []
316 for (const p of PluginManager.Instance.getExternalAuths()) {
317 for (const auth of p.externalAuths) {
322 authName: auth.authName,
323 authDisplayName: auth.authDisplayName()
331 static get Instance () {
332 return this.instance || (this.instance = new this())
336 // ---------------------------------------------------------------------------