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

300 lines
4.5 KiB
TypeScript
Raw Normal View History

2021-12-24 03:40:51 -06:00
import { ClientScriptJSON } from '../plugins/plugin-package-json.model'
2020-05-28 04:15:38 -05:00
import { NSFWPolicyType } from '../videos/nsfw-policy.type'
import { VideoPrivacy } from '../videos/video-privacy.enum'
2020-05-28 04:15:38 -05:00
import { BroadcastMessageLevel } from './broadcast-message-level.type'
2019-07-08 08:54:08 -05:00
2019-07-10 07:06:19 -05:00
export interface ServerConfigPlugin {
2019-07-08 08:54:08 -05:00
name: string
2021-12-29 07:08:07 -06:00
npmName: string
2019-07-08 08:54:08 -05:00
version: string
description: string
2021-12-24 03:40:51 -06:00
clientScripts: { [name: string]: ClientScriptJSON }
2019-07-08 08:54:08 -05:00
}
2019-07-10 07:06:19 -05:00
export interface ServerConfigTheme extends ServerConfigPlugin {
css: string[]
}
2020-04-28 07:49:03 -05:00
export interface RegisteredExternalAuthConfig {
npmName: string
2020-04-29 03:42:35 -05:00
name: string
version: string
2020-04-28 07:49:03 -05:00
authName: string
authDisplayName: string
}
export interface RegisteredIdAndPassAuthConfig {
npmName: string
2020-04-29 03:42:35 -05:00
name: string
version: string
2020-04-28 07:49:03 -05:00
authName: string
weight: number
}
2017-06-17 04:28:11 -05:00
export interface ServerConfig {
2018-01-31 10:47:36 -06:00
serverVersion: string
serverCommit?: string
2018-01-31 10:47:36 -06:00
client: {
videos: {
miniature: {
displayAuthorAvatar: boolean
2021-10-12 07:25:30 -05: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 04:35:43 -05:00
webadmin: {
configuration: {
edition: {
allowed: boolean
}
}
2021-10-14 07:14:57 -05:00
}
2021-10-14 04:35:43 -05:00
2018-01-31 10:47:36 -06:00
instance: {
2018-03-01 06:57:29 -06:00
name: string
2018-03-15 08:31:08 -05:00
shortDescription: string
2019-02-20 08:36:43 -06:00
isNSFW: boolean
defaultNSFWPolicy: NSFWPolicyType
defaultClientRoute: string
customizations: {
javascript: string
css: string
}
2018-01-31 10:47:36 -06:00
}
search: {
remoteUri: {
users: boolean
anonymous: boolean
}
2020-05-29 09:16:24 -05:00
searchIndex: {
enabled: boolean
url: string
disableLocalSearch: boolean
isDefaultSearch: boolean
}
}
2019-07-09 04:45:19 -05:00
plugin: {
registered: ServerConfigPlugin[]
2020-04-28 07:49:03 -05:00
registeredExternalAuths: RegisteredExternalAuthConfig[]
registeredIdAndPassAuths: RegisteredIdAndPassAuthConfig[]
2019-07-09 04:45:19 -05:00
}
theme: {
2019-07-10 07:06:19 -05:00
registered: ServerConfigTheme[]
2019-07-09 04:45:19 -05:00
default: string
}
2019-07-08 08:54:08 -05:00
email: {
enabled: boolean
}
2019-01-09 08:14:29 -06:00
contactForm: {
enabled: boolean
}
2017-06-17 04:28:11 -05:00
signup: {
2020-01-31 09:56:52 -06:00
allowed: boolean
2019-01-29 01:37:25 -06:00
allowedForCurrentIP: boolean
requiresEmailVerification: boolean
2023-01-19 02:27:16 -06:00
requiresApproval: boolean
minimumAge: number
2017-06-17 04:28:11 -05:00
}
2018-01-31 10:47:36 -06:00
transcoding: {
2019-01-29 01:37:25 -06:00
hls: {
enabled: boolean
}
webtorrent: {
enabled: boolean
}
enabledResolutions: number[]
profile: string
availableProfiles: string[]
remoteRunners: {
enabled: boolean
}
}
2018-01-31 10:47:36 -06:00
live: {
enabled: boolean
2022-03-04 06:40:02 -06:00
allowReplay: boolean
latencySetting: {
enabled: boolean
}
2020-09-25 09:19:35 -05:00
maxDuration: number
2020-10-28 09:24:40 -05:00
maxInstanceLives: number
maxUserLives: number
2020-09-25 09:19:35 -05:00
transcoding: {
enabled: boolean
remoteRunners: {
enabled: boolean
}
enabledResolutions: number[]
profile: string
availableProfiles: string[]
}
2021-01-11 02:20:44 -06:00
rtmp: {
port: number
}
}
2022-03-22 10:58:49 -05:00
videoStudio: {
2022-02-11 03:51:33 -06:00
enabled: boolean
remoteRunners: {
enabled: boolean
}
2022-02-11 03:51:33 -06:00
}
2018-08-03 04:10:31 -05:00
import: {
2018-08-03 10:00:19 -05:00
videos: {
2018-08-03 04:10:31 -05:00
http: {
enabled: boolean
}
2018-08-07 03:07:53 -05:00
torrent: {
enabled: boolean
}
2018-08-03 04:10:31 -05:00
}
Channel sync (#5135) * Add external channel URL for channel update / creation (#754) * Disallow synchronisation if user has no video quota (#754) * More constraints serverside (#754) * Disable sync if server configuration does not allow HTTP import (#754) * Working version synchronizing videos with a job (#754) TODO: refactoring, too much code duplication * More logs and try/catch (#754) * Fix eslint error (#754) * WIP: support synchronization time change (#754) * New frontend #754 * WIP: Create sync front (#754) * Enhance UI, sync creation form (#754) * Warning message when HTTP upload is disallowed * More consistent names (#754) * Binding Front with API (#754) * Add a /me API (#754) * Improve list UI (#754) * Implement creation and deletion routes (#754) * Lint (#754) * Lint again (#754) * WIP: UI for triggering import existing videos (#754) * Implement jobs for syncing and importing channels * Don't sync videos before sync creation + avoid concurrency issue (#754) * Cleanup (#754) * Cleanup: OpenAPI + API rework (#754) * Remove dead code (#754) * Eslint (#754) * Revert the mess with whitespaces in constants.ts (#754) * Some fixes after rebase (#754) * Several fixes after PR remarks (#754) * Front + API: Rename video-channels-sync to video-channel-syncs (#754) * Allow enabling channel sync through UI (#754) * getChannelInfo (#754) * Minor fixes: openapi + model + sql (#754) * Simplified API validators (#754) * Rename MChannelSync to MChannelSyncChannel (#754) * Add command for VideoChannelSync (#754) * Use synchronization.enabled config (#754) * Check parameters test + some fixes (#754) * Fix conflict mistake (#754) * Restrict access to video channel sync list API (#754) * Start adding unit test for synchronization (#754) * Continue testing (#754) * Tests finished + convertion of job to scheduler (#754) * Add lastSyncAt field (#754) * Fix externalRemoteUrl sort + creation date not well formatted (#754) * Small fix (#754) * Factorize addYoutubeDLImport and buildVideo (#754) * Check duplicates on channel not on users (#754) * factorize thumbnail generation (#754) * Fetch error should return status 400 (#754) * Separate video-channel-import and video-channel-sync-latest (#754) * Bump DB migration version after rebase (#754) * Prettier states in UI table (#754) * Add DefaultScope in VideoChannelSyncModel (#754) * Fix audit logs (#754) * Ensure user can upload when importing channel + minor fixes (#754) * Mark synchronization as failed on exception + typos (#754) * Change REST API for importing videos into channel (#754) * Add option for fully synchronize a chnanel (#754) * Return a whole sync object on creation to avoid tricks in Front (#754) * Various remarks (#754) * Single quotes by default (#754) * Rename synchronization to video_channel_synchronization * Add check.latest_videos_count and max_per_user options (#754) * Better channel rendering in list #754 * Allow sorting with channel name and state (#754) * Add missing tests for channel imports (#754) * Prefer using a parent job for channel sync * Styling * Client styling Co-authored-by: Chocobozzz <me@florianbigard.com>
2022-08-10 02:53:39 -05:00
videoChannelSynchronization: {
enabled: boolean
}
2018-08-03 04:10:31 -05:00
}
autoBlacklist: {
videos: {
ofUsers: {
enabled: boolean
}
}
}
2018-01-03 04:10:40 -06:00
avatar: {
file: {
size: {
max: number
2019-01-29 01:37:25 -06:00
}
2018-01-03 04:10:40 -06:00
extensions: string[]
}
}
2018-01-31 10:47:36 -06:00
2021-04-07 10:01:29 -05:00
banner: {
file: {
size: {
max: number
}
extensions: string[]
}
}
2018-01-03 04:10:40 -06:00
video: {
image: {
size: {
max: number
}
extensions: string[]
2020-01-31 09:56:52 -06:00
}
2018-01-03 04:10:40 -06:00
file: {
extensions: string[]
}
}
2018-07-12 12:02:00 -05:00
videoCaption: {
file: {
size: {
max: number
2020-01-31 09:56:52 -06:00
}
2018-07-12 12:02:00 -05:00
extensions: string[]
}
}
user: {
videoQuota: number
videoQuotaDaily: number
}
videoChannels: {
maxPerUser: number
}
trending: {
videos: {
intervalDays: number
2021-01-27 10:15:21 -06:00
algorithms: {
enabled: string[]
default: string
}
}
}
2019-04-10 02:23:18 -05:00
tracker: {
enabled: boolean
}
followings: {
instance: {
autoFollowIndex: {
indexUrl: string
}
}
}
2020-05-28 04:15:38 -05:00
broadcastMessage: {
enabled: boolean
message: string
level: BroadcastMessageLevel
dismissable: boolean
}
homepage: {
enabled: boolean
}
2017-06-17 04:28:11 -05:00
}
2021-05-14 05:04:44 -05:00
export type HTMLServerConfig = Omit<ServerConfig, 'signup'>