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

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