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