PeerTube/shared/models/server/server-config.model.ts

284 lines
4.3 KiB
TypeScript
Raw Normal View History

import { VideoPrivacy } from '../videos/video-privacy.enum'
2021-12-24 10:40:51 +01:00
import { ClientScriptJSON } from '../plugins/plugin-package-json.model'
2020-05-28 11:15:38 +02:00
import { NSFWPolicyType } from '../videos/nsfw-policy.type'
import { BroadcastMessageLevel } from './broadcast-message-level.type'
2019-07-08 15:54:08 +02:00
2019-07-10 14:06:19 +02:00
export interface ServerConfigPlugin {
2019-07-08 15:54:08 +02:00
name: string
2021-12-29 14:08:07 +01:00
npmName: string
2019-07-08 15:54:08 +02:00
version: string
description: string
2021-12-24 10:40:51 +01:00
clientScripts: { [name: string]: ClientScriptJSON }
2019-07-08 15:54:08 +02:00
}
2019-07-10 14:06:19 +02:00
export interface ServerConfigTheme extends ServerConfigPlugin {
css: string[]
}
2020-04-28 14:49:03 +02:00
export interface RegisteredExternalAuthConfig {
npmName: string
2020-04-29 10:42:35 +02:00
name: string
version: string
2020-04-28 14:49:03 +02:00
authName: string
authDisplayName: string
}
export interface RegisteredIdAndPassAuthConfig {
npmName: string
2020-04-29 10:42:35 +02:00
name: string
version: string
2020-04-28 14:49:03 +02:00
authName: string
weight: number
}
2017-06-17 11:28:11 +02:00
export interface ServerConfig {
2018-01-31 17:47:36 +01:00
serverVersion: string
serverCommit?: string
2018-01-31 17:47:36 +01:00
client: {
videos: {
miniature: {
displayAuthorAvatar: boolean
2021-10-12 14:25:30 +02:00
preferAuthorDisplayName: boolean
}
resumableUpload: {
maxChunkSize: number
}
}
menu: {
login: {
redirectOnSingleExternalAuth: boolean
}
}
}
defaults: {
publish: {
downloadEnabled: boolean
commentsEnabled: boolean
privacy: VideoPrivacy
licence: number
}
p2p: {
webapp: {
enabled: boolean
}
embed: {
enabled: boolean
}
}
}
2021-10-14 11:35:43 +02:00
webadmin: {
configuration: {
edition: {
allowed: boolean
}
}
2021-10-14 14:14:57 +02:00
}
2021-10-14 11:35:43 +02:00
2018-01-31 17:47:36 +01:00
instance: {
2018-03-01 13:57:29 +01:00
name: string
2018-03-15 14:31:08 +01:00
shortDescription: string
2019-02-20 15:36:43 +01:00
isNSFW: boolean
defaultNSFWPolicy: NSFWPolicyType
defaultClientRoute: string
customizations: {
javascript: string
css: string
}
2018-01-31 17:47:36 +01:00
}
search: {
remoteUri: {
users: boolean
anonymous: boolean
}
2020-05-29 16:16:24 +02:00
searchIndex: {
enabled: boolean
url: string
disableLocalSearch: boolean
isDefaultSearch: boolean
}
}
2019-07-09 11:45:19 +02:00
plugin: {
registered: ServerConfigPlugin[]
2020-04-28 14:49:03 +02:00
registeredExternalAuths: RegisteredExternalAuthConfig[]
registeredIdAndPassAuths: RegisteredIdAndPassAuthConfig[]
2019-07-09 11:45:19 +02:00
}
theme: {
2019-07-10 14:06:19 +02:00
registered: ServerConfigTheme[]
2019-07-09 11:45:19 +02:00
default: string
}
2019-07-08 15:54:08 +02:00
email: {
enabled: boolean
}
2019-01-09 15:14:29 +01:00
contactForm: {
enabled: boolean
}
2017-06-17 11:28:11 +02:00
signup: {
2020-01-31 16:56:52 +01:00
allowed: boolean
2019-01-29 08:37:25 +01:00
allowedForCurrentIP: boolean
requiresEmailVerification: boolean
minimumAge: number
2017-06-17 11:28:11 +02:00
}
2018-01-31 17:47:36 +01:00
transcoding: {
2019-01-29 08:37:25 +01:00
hls: {
enabled: boolean
}
webtorrent: {
enabled: boolean
}
enabledResolutions: number[]
profile: string
availableProfiles: string[]
}
2018-01-31 17:47:36 +01:00
live: {
enabled: boolean
2022-03-04 13:40:02 +01:00
allowReplay: boolean
latencySetting: {
enabled: boolean
}
2020-09-25 16:19:35 +02:00
maxDuration: number
2020-10-28 15:24:40 +01:00
maxInstanceLives: number
maxUserLives: number
2020-09-25 16:19:35 +02:00
transcoding: {
enabled: boolean
enabledResolutions: number[]
profile: string
availableProfiles: string[]
}
2021-01-11 09:20:44 +01:00
rtmp: {
port: number
}
}
2022-03-22 16:58:49 +01:00
videoStudio: {
2022-02-11 10:51:33 +01:00
enabled: boolean
}
2018-08-03 11:10:31 +02:00
import: {
2018-08-03 17:00:19 +02:00
videos: {
2018-08-03 11:10:31 +02:00
http: {
enabled: boolean
}
2018-08-07 10:07:53 +02:00
torrent: {
enabled: boolean
}
2018-08-03 11:10:31 +02:00
}
}
autoBlacklist: {
videos: {
ofUsers: {
enabled: boolean
}
}
}
2018-01-03 11:10:40 +01:00
avatar: {
file: {
size: {
max: number
2019-01-29 08:37:25 +01:00
}
2018-01-03 11:10:40 +01:00
extensions: string[]
}
}
2018-01-31 17:47:36 +01:00
2021-04-07 17:01:29 +02:00
banner: {
file: {
size: {
max: number
}
extensions: string[]
}
}
2018-01-03 11:10:40 +01:00
video: {
image: {
size: {
max: number
}
extensions: string[]
2020-01-31 16:56:52 +01:00
}
2018-01-03 11:10:40 +01:00
file: {
extensions: string[]
}
}
2018-07-12 19:02:00 +02:00
videoCaption: {
file: {
size: {
max: number
2020-01-31 16:56:52 +01:00
}
2018-07-12 19:02:00 +02:00
extensions: string[]
}
}
user: {
videoQuota: number
videoQuotaDaily: number
}
videoChannels: {
maxPerUser: number
}
trending: {
videos: {
intervalDays: number
2021-01-27 17:15:21 +01:00
algorithms: {
enabled: string[]
default: string
}
}
}
2019-04-10 09:23:18 +02:00
tracker: {
enabled: boolean
}
followings: {
instance: {
autoFollowIndex: {
indexUrl: string
}
}
}
2020-05-28 11:15:38 +02:00
broadcastMessage: {
enabled: boolean
message: string
level: BroadcastMessageLevel
dismissable: boolean
}
homepage: {
enabled: boolean
}
2017-06-17 11:28:11 +02:00
}
2021-05-14 12:04:44 +02:00
export type HTMLServerConfig = Omit<ServerConfig, 'signup'>