1 import { getServerCommit } from '@server/helpers/version'
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/default-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 displayAuthorAvatar: CONFIG.CLIENT.VIDEOS.MINIATURE.DISPLAY_AUTHOR_AVATAR,
50 preferAuthorDisplayName: CONFIG.CLIENT.VIDEOS.MINIATURE.PREFER_AUTHOR_DISPLAY_NAME
53 maxChunkSize: CONFIG.CLIENT.VIDEOS.RESUMABLE_UPLOAD.MAX_CHUNK_SIZE
58 redirectOnSingleExternalAuth: CONFIG.CLIENT.MENU.LOGIN.REDIRECT_ON_SINGLE_EXTERNAL_AUTH
65 downloadEnabled: CONFIG.DEFAULTS.PUBLISH.DOWNLOAD_ENABLED,
66 commentsEnabled: CONFIG.DEFAULTS.PUBLISH.COMMENTS_ENABLED,
67 privacy: CONFIG.DEFAULTS.PUBLISH.PRIVACY,
68 licence: CONFIG.DEFAULTS.PUBLISH.LICENCE
72 enabled: CONFIG.DEFAULTS.P2P.WEBAPP.ENABLED
75 enabled: CONFIG.DEFAULTS.P2P.EMBED.ENABLED
83 allowed: CONFIG.WEBADMIN.CONFIGURATION.EDITION.ALLOWED
89 name: CONFIG.INSTANCE.NAME,
90 shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,
91 isNSFW: CONFIG.INSTANCE.IS_NSFW,
92 defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
93 defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,
95 javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT,
96 css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS
101 users: CONFIG.SEARCH.REMOTE_URI.USERS,
102 anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS
105 enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,
106 url: CONFIG.SEARCH.SEARCH_INDEX.URL,
107 disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,
108 isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH
112 registered: this.getRegisteredPlugins(),
113 registeredExternalAuths: this.getExternalAuthsPlugins(),
114 registeredIdAndPassAuths: this.getIdAndPassAuthPlugins()
117 registered: this.getRegisteredThemes(),
118 default: defaultTheme
121 enabled: isEmailEnabled()
124 enabled: CONFIG.CONTACT_FORM.ENABLED
126 serverVersion: PEERTUBE_VERSION,
127 serverCommit: this.serverCommit,
130 enabled: CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.REMOTE_RUNNERS.ENABLED
133 enabled: CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.HLS.ENABLED
136 enabled: CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.WEBTORRENT.ENABLED
138 enabledResolutions: this.getEnabledResolutions('vod'),
139 profile: CONFIG.TRANSCODING.PROFILE,
140 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('vod')
143 enabled: CONFIG.LIVE.ENABLED,
145 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
147 enabled: CONFIG.LIVE.LATENCY_SETTING.ENABLED
150 maxDuration: CONFIG.LIVE.MAX_DURATION,
151 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
152 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
155 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
157 enabled: CONFIG.LIVE.TRANSCODING.ENABLED && CONFIG.LIVE.TRANSCODING.REMOTE_RUNNERS.ENABLED
159 enabledResolutions: this.getEnabledResolutions('live'),
160 profile: CONFIG.LIVE.TRANSCODING.PROFILE,
161 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('live')
165 port: CONFIG.LIVE.RTMP.PORT
169 enabled: CONFIG.VIDEO_STUDIO.ENABLED
174 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
177 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
180 videoChannelSynchronization: {
181 enabled: CONFIG.IMPORT.VIDEO_CHANNEL_SYNCHRONIZATION.ENABLED
187 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
194 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
196 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
202 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
204 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
209 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
211 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
215 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
221 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
223 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
227 videoQuota: CONFIG.USER.VIDEO_QUOTA,
228 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
231 maxPerUser: CONFIG.VIDEO_CHANNELS.MAX_PER_USER
235 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS,
237 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
238 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
243 enabled: CONFIG.TRACKER.ENABLED
249 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
255 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
256 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
257 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
258 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
262 enabled: this.homepageEnabled
267 async getServerConfig (ip?: string): Promise<ServerConfig> {
268 const { allowed } = await Hooks.wrapPromiseFun(
273 signupMode: CONFIG.SIGNUP.REQUIRES_APPROVAL
274 ? 'request-registration'
275 : 'direct-registration'
278 CONFIG.SIGNUP.REQUIRES_APPROVAL
279 ? 'filter:api.user.request-signup.allowed.result'
280 : 'filter:api.user.signup.allowed.result'
283 const allowedForCurrentIP = isSignupAllowedForCurrentIP(ip)
288 minimumAge: CONFIG.SIGNUP.MINIMUM_AGE,
289 requiresApproval: CONFIG.SIGNUP.REQUIRES_APPROVAL,
290 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
293 const htmlConfig = await this.getHTMLServerConfig()
295 return { ...htmlConfig, signup }
298 getRegisteredThemes () {
299 return PluginManager.Instance.getRegisteredThemes()
301 npmName: PluginModel.buildNpmName(t.name, t.type),
304 description: t.description,
306 clientScripts: t.clientScripts
310 getRegisteredPlugins () {
311 return PluginManager.Instance.getRegisteredPlugins()
313 npmName: PluginModel.buildNpmName(p.name, p.type),
316 description: p.description,
317 clientScripts: p.clientScripts
321 getEnabledResolutions (type: 'vod' | 'live') {
322 const transcoding = type === 'vod'
324 : CONFIG.LIVE.TRANSCODING
326 return Object.keys(transcoding.RESOLUTIONS)
327 .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true)
328 .map(r => parseInt(r, 10))
331 private getIdAndPassAuthPlugins () {
332 const result: RegisteredIdAndPassAuthConfig[] = []
334 for (const p of PluginManager.Instance.getIdAndPassAuths()) {
335 for (const auth of p.idAndPassAuths) {
340 authName: auth.authName,
341 weight: auth.getWeight()
349 private getExternalAuthsPlugins () {
350 const result: RegisteredExternalAuthConfig[] = []
352 for (const p of PluginManager.Instance.getExternalAuths()) {
353 for (const auth of p.externalAuths) {
358 authName: auth.authName,
359 authDisplayName: auth.authDisplayName()
367 static get Instance () {
368 return this.instance || (this.instance = new this())
372 // ---------------------------------------------------------------------------