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.HLS.ENABLED
133 enabled: CONFIG.TRANSCODING.WEBTORRENT.ENABLED
135 enabledResolutions: this.getEnabledResolutions('vod'),
136 profile: CONFIG.TRANSCODING.PROFILE,
137 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('vod')
140 enabled: CONFIG.LIVE.ENABLED,
142 allowReplay: CONFIG.LIVE.ALLOW_REPLAY,
144 enabled: CONFIG.LIVE.LATENCY_SETTING.ENABLED
147 maxDuration: CONFIG.LIVE.MAX_DURATION,
148 maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,
149 maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,
152 enabled: CONFIG.LIVE.TRANSCODING.ENABLED,
153 enabledResolutions: this.getEnabledResolutions('live'),
154 profile: CONFIG.LIVE.TRANSCODING.PROFILE,
155 availableProfiles: VideoTranscodingProfilesManager.Instance.getAvailableProfiles('live')
159 port: CONFIG.LIVE.RTMP.PORT
163 enabled: CONFIG.VIDEO_STUDIO.ENABLED
168 enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED
171 enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED
174 videoChannelSynchronization: {
175 enabled: CONFIG.IMPORT.VIDEO_CHANNEL_SYNCHRONIZATION.ENABLED
181 enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED
188 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
190 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
196 max: CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max
198 extensions: CONSTRAINTS_FIELDS.ACTORS.IMAGE.EXTNAME
203 extensions: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.EXTNAME,
205 max: CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max
209 extensions: CONSTRAINTS_FIELDS.VIDEOS.EXTNAME
215 max: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max
217 extensions: CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
221 videoQuota: CONFIG.USER.VIDEO_QUOTA,
222 videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY
225 maxPerUser: CONFIG.VIDEO_CHANNELS.MAX_PER_USER
229 intervalDays: CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS,
231 enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,
232 default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT
237 enabled: CONFIG.TRACKER.ENABLED
243 indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL
249 enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,
250 message: CONFIG.BROADCAST_MESSAGE.MESSAGE,
251 level: CONFIG.BROADCAST_MESSAGE.LEVEL,
252 dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE
256 enabled: this.homepageEnabled
261 async getServerConfig (ip?: string): Promise<ServerConfig> {
262 const { allowed } = await Hooks.wrapPromiseFun(
267 'filter:api.user.signup.allowed.result'
270 const allowedForCurrentIP = isSignupAllowedForCurrentIP(ip)
275 minimumAge: CONFIG.SIGNUP.MINIMUM_AGE,
276 requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION
279 const htmlConfig = await this.getHTMLServerConfig()
281 return { ...htmlConfig, signup }
284 getRegisteredThemes () {
285 return PluginManager.Instance.getRegisteredThemes()
287 npmName: PluginModel.buildNpmName(t.name, t.type),
290 description: t.description,
292 clientScripts: t.clientScripts
296 getRegisteredPlugins () {
297 return PluginManager.Instance.getRegisteredPlugins()
299 npmName: PluginModel.buildNpmName(p.name, p.type),
302 description: p.description,
303 clientScripts: p.clientScripts
307 getEnabledResolutions (type: 'vod' | 'live') {
308 const transcoding = type === 'vod'
310 : CONFIG.LIVE.TRANSCODING
312 return Object.keys(transcoding.RESOLUTIONS)
313 .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true)
314 .map(r => parseInt(r, 10))
317 private getIdAndPassAuthPlugins () {
318 const result: RegisteredIdAndPassAuthConfig[] = []
320 for (const p of PluginManager.Instance.getIdAndPassAuths()) {
321 for (const auth of p.idAndPassAuths) {
326 authName: auth.authName,
327 weight: auth.getWeight()
335 private getExternalAuthsPlugins () {
336 const result: RegisteredExternalAuthConfig[] = []
338 for (const p of PluginManager.Instance.getExternalAuths()) {
339 for (const auth of p.externalAuths) {
344 authName: auth.authName,
345 authDisplayName: auth.authDisplayName()
353 static get Instance () {
354 return this.instance || (this.instance = new this())
358 // ---------------------------------------------------------------------------