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 { PluginModel } from '@server/models/server/plugin'
7 import { HTMLServerConfig, RegisteredExternalAuthConfig, RegisteredIdAndPassAuthConfig, ServerConfig } from '@shared/models'
8 import { Hooks } from './plugins/hooks'
9 import { PluginManager } from './plugins/plugin-manager'
10 import { getThemeOrDefault } from './plugins/theme-utils'
11 import { VideoTranscodingProfilesManager } from './transcoding/video-transcoding-profiles'
15 * Used to send the server config to clients (using REST/API or plugins API)
16 * We need a singleton class to manage config state depending on external events (to build menu entries etc)
20 class ServerConfigManager {
22 private static instance: ServerConfigManager
24 private serverCommit: string
26 private homepageEnabled = false
28 private constructor () {}
31 const instanceHomepage = await ActorCustomPageModel.loadInstanceHomepage()
33 this.updateHomepageState(instanceHomepage?.content)
36 updateHomepageState (content: string) {
37 this.homepageEnabled = !!content
40 async getHTMLServerConfig (): Promise<HTMLServerConfig> {
41 if (this.serverCommit === undefined) this.serverCommit = await getServerCommit()
43 const defaultTheme = getThemeOrDefault(CONFIG.THEME.DEFAULT, DEFAULT_THEME_NAME)
49 preferAuthorDisplayName: CONFIG.CLIENT.VIDEOS.MINIATURE.PREFER_AUTHOR_DISPLAY_NAME
54 redirectOnSingleExternalAuth: CONFIG.CLIENT.MENU.LOGIN.REDIRECT_ON_SINGLE_EXTERNAL_AUTH
61 downloadEnabled: CONFIG.DEFAULTS.PUBLISH.DOWNLOAD_ENABLED,
62 commentsEnabled: CONFIG.DEFAULTS.PUBLISH.COMMENTS_ENABLED,
63 privacy: CONFIG.DEFAULTS.PUBLISH.PRIVACY,
64 licence: CONFIG.DEFAULTS.PUBLISH.LICENCE
68 enabled: CONFIG.DEFAULTS.P2P.WEBAPP.ENABLED
71 enabled: CONFIG.DEFAULTS.P2P.EMBED.ENABLED
79 allowed: CONFIG.WEBADMIN.CONFIGURATION.EDITION.ALLOWED
85 name: CONFIG.INSTANCE.NAME,
86 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
87 isNSFW: CONFIG.INSTANCE.IS_NSFW,
88 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
89 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
91 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
92 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
97 users: CONFIG.SEARCH.REMOTE_URI.USERS,
98 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
101 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
102 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
103 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
104 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
108 registered: this.getRegisteredPlugins(),
109 registeredExternalAuths: this.getExternalAuthsPlugins(),
110 registeredIdAndPassAuths: this.getIdAndPassAuthPlugins()
113 registered: this.getRegisteredThemes(),
114 default: defaultTheme
117 enabled: isEmailEnabled()
120 enabled: CONFIG.CONTACT_FORM.ENABLED
122 serverVersion: PEERTUBE_VERSION,
123 serverCommit: this.serverCommit,
126 enabled: CONFIG.TRANSCODING.HLS.ENABLED
129 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
131 enabledResolutions: this.getEnabledResolutions('vod'),
132 profile: CONFIG.TRANSCODING.PROFILE,
133 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('vod')
136 enabled: CONFIG.LIVE.ENABLED,
138 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
139 maxDuration: CONFIG.LIVE.MAX_DURATION,
140 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
141 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
144 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
145 enabledResolutions: this.getEnabledResolutions('live'),
146 profile: CONFIG.LIVE.TRANSCODING.PROFILE,
147 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('live')
151 port: CONFIG.LIVE.RTMP.PORT
157 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
160 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
167 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
174 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
176 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
182 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
184 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
189 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
191 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
195 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
201 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
203 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
207 videoQuota: CONFIG.USER.VIDEO_QUOTA,
208 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
211 maxPerUser: CONFIG.VIDEO_CHANNELS.MAX_PER_USER
215 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS,
217 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
218 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
223 enabled: CONFIG.TRACKER.ENABLED
229 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
235 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
236 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
237 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
238 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
242 enabled: this.homepageEnabled
247 async getServerConfig (ip?: string): Promise<ServerConfig> {
248 const { allowed } = await Hooks.wrapPromiseFun(
253 'filter:api.user.signup.allowed.result'
256 const allowedForCurrentIP = isSignupAllowedForCurrentIP(ip)
261 minimumAge: CONFIG.SIGNUP.MINIMUM_AGE,
262 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
265 const htmlConfig = await this.getHTMLServerConfig()
267 return { ...htmlConfig, signup }
270 getRegisteredThemes () {
271 return PluginManager.Instance.getRegisteredThemes()
273 npmName: PluginModel.buildNpmName(t.name, t.type),
276 description: t.description,
278 clientScripts: t.clientScripts
282 getRegisteredPlugins () {
283 return PluginManager.Instance.getRegisteredPlugins()
285 npmName: PluginModel.buildNpmName(p.name, p.type),
288 description: p.description,
289 clientScripts: p.clientScripts
293 getEnabledResolutions (type: 'vod' | 'live') {
294 const transcoding = type === 'vod'
296 : CONFIG.LIVE.TRANSCODING
298 return Object.keys(transcoding.RESOLUTIONS)
299 .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true)
300 .map(r => parseInt(r, 10))
303 private getIdAndPassAuthPlugins () {
304 const result: RegisteredIdAndPassAuthConfig[] = []
306 for (const p of PluginManager.Instance.getIdAndPassAuths()) {
307 for (const auth of p.idAndPassAuths) {
312 authName: auth.authName,
313 weight: auth.getWeight()
321 private getExternalAuthsPlugins () {
322 const result: RegisteredExternalAuthConfig[] = []
324 for (const p of PluginManager.Instance.getExternalAuths()) {
325 for (const auth of p.externalAuths) {
330 authName: auth.authName,
331 authDisplayName: auth.authDisplayName()
339 static get Instance () {
340 return this.instance || (this.instance = new this())
344 // ---------------------------------------------------------------------------