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

   1 import { VideoPrivacy } from '../videos/video-privacy.enum'
   2 import { ClientScriptJSON } from '../plugins/plugin-package-json.model'
   3 import { NSFWPolicyType } from '../videos/nsfw-policy.type'
   4 import { BroadcastMessageLevel } from './broadcast-message-level.type'
   5
   6 export interface ServerConfigPlugin {
   7   name: string
   8   npmName: string
   9   version: string
  10   description: string
  11   clientScripts: { [name: string]: ClientScriptJSON }
  12 }
  13
  14 export interface ServerConfigTheme extends ServerConfigPlugin {
  15   css: string[]
  16 }
  17
  18 export interface RegisteredExternalAuthConfig {
  19   npmName: string
  20   name: string
  21   version: string
  22   authName: string
  23   authDisplayName: string
  24 }
  25
  26 export interface RegisteredIdAndPassAuthConfig {
  27   npmName: string
  28   name: string
  29   version: string
  30   authName: string
  31   weight: number
  32 }
  33
  34 export interface ServerConfig {
  35   serverVersion: string
  36   serverCommit?: string
  37
  38   client: {
  39     videos: {
  40       miniature: {
  41         preferAuthorDisplayName: boolean
  42       }
  43     }
  44
  45     menu: {
  46       login: {
  47         redirectOnSingleExternalAuth: boolean
  48       }
  49     }
  50   }
  51
  52   defaults: {
  53     publish: {
  54       downloadEnabled: boolean
  55       commentsEnabled: boolean
  56       privacy: VideoPrivacy
  57       licence: number
  58     }
  59
  60     p2p: {
  61       webapp: {
  62         enabled: boolean
  63       }
  64
  65       embed: {
  66         enabled: boolean
  67       }
  68     }
  69   }
  70
  71   webadmin: {
  72     configuration: {
  73       edition: {
  74         allowed: boolean
  75       }
  76     }
  77   }
  78
  79   instance: {
  80     name: string
  81     shortDescription: string
  82     isNSFW: boolean
  83     defaultNSFWPolicy: NSFWPolicyType
  84     defaultClientRoute: string
  85     customizations: {
  86       javascript: string
  87       css: string
  88     }
  89   }
  90
  91   search: {
  92     remoteUri: {
  93       users: boolean
  94       anonymous: boolean
  95     }
  96
  97     searchIndex: {
  98       enabled: boolean
  99       url: string
 100       disableLocalSearch: boolean
 101       isDefaultSearch: boolean
 102     }
 103   }
 104
 105   plugin: {
 106     registered: ServerConfigPlugin[]
 107
 108     registeredExternalAuths: RegisteredExternalAuthConfig[]
 109
 110     registeredIdAndPassAuths: RegisteredIdAndPassAuthConfig[]
 111   }
 112
 113   theme: {
 114     registered: ServerConfigTheme[]
 115     default: string
 116   }
 117
 118   email: {
 119     enabled: boolean
 120   }
 121
 122   contactForm: {
 123     enabled: boolean
 124   }
 125
 126   signup: {
 127     allowed: boolean
 128     allowedForCurrentIP: boolean
 129     requiresEmailVerification: boolean
 130     minimumAge: number
 131   }
 132
 133   transcoding: {
 134     hls: {
 135       enabled: boolean
 136     }
 137
 138     webtorrent: {
 139       enabled: boolean
 140     }
 141
 142     enabledResolutions: number[]
 143
 144     profile: string
 145     availableProfiles: string[]
 146   }
 147
 148   live: {
 149     enabled: boolean
 150
 151     maxDuration: number
 152     maxInstanceLives: number
 153     maxUserLives: number
 154     allowReplay: boolean
 155
 156     transcoding: {
 157       enabled: boolean
 158
 159       enabledResolutions: number[]
 160
 161       profile: string
 162       availableProfiles: string[]
 163     }
 164
 165     rtmp: {
 166       port: number
 167     }
 168   }
 169
 170   import: {
 171     videos: {
 172       http: {
 173         enabled: boolean
 174       }
 175       torrent: {
 176         enabled: boolean
 177       }
 178     }
 179   }
 180
 181   autoBlacklist: {
 182     videos: {
 183       ofUsers: {
 184         enabled: boolean
 185       }
 186     }
 187   }
 188
 189   avatar: {
 190     file: {
 191       size: {
 192         max: number
 193       }
 194       extensions: string[]
 195     }
 196   }
 197
 198   banner: {
 199     file: {
 200       size: {
 201         max: number
 202       }
 203       extensions: string[]
 204     }
 205   }
 206
 207   video: {
 208     image: {
 209       size: {
 210         max: number
 211       }
 212       extensions: string[]
 213     }
 214     file: {
 215       extensions: string[]
 216     }
 217   }
 218
 219   videoCaption: {
 220     file: {
 221       size: {
 222         max: number
 223       }
 224       extensions: string[]
 225     }
 226   }
 227
 228   user: {
 229     videoQuota: number
 230     videoQuotaDaily: number
 231   }
 232
 233   videoChannels: {
 234     maxPerUser: number
 235   }
 236
 237   trending: {
 238     videos: {
 239       intervalDays: number
 240       algorithms: {
 241         enabled: string[]
 242         default: string
 243       }
 244     }
 245   }
 246
 247   tracker: {
 248     enabled: boolean
 249   }
 250
 251   followings: {
 252     instance: {
 253       autoFollowIndex: {
 254         indexUrl: string
 255       }
 256     }
 257   }
 258
 259   broadcastMessage: {
 260     enabled: boolean
 261     message: string
 262     level: BroadcastMessageLevel
 263     dismissable: boolean
 264   }
 265
 266   homepage: {
 267     enabled: boolean
 268   }
 269 }
 270
 271 export type HTMLServerConfig = Omit<ServerConfig, 'signup'>