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   }
  88
  89   transcoding: {
  90     hls: {
  91       enabled: boolean
  92     }
  93
  94     webtorrent: {
  95       enabled: boolean
  96     }
  97
  98     enabledResolutions: number[]
  99
 100     profile: string
 101     availableProfiles: string[]
 102   }
 103
 104   live: {
 105     enabled: boolean
 106
 107     maxDuration: number
 108     maxInstanceLives: number
 109     maxUserLives: number
 110     allowReplay: boolean
 111
 112     transcoding: {
 113       enabled: boolean
 114
 115       enabledResolutions: number[]
 116
 117       profile: string
 118       availableProfiles: string[]
 119     }
 120
 121     rtmp: {
 122       port: number
 123     }
 124   }
 125
 126   import: {
 127     videos: {
 128       http: {
 129         enabled: boolean
 130       }
 131       torrent: {
 132         enabled: boolean
 133       }
 134     }
 135   }
 136
 137   autoBlacklist: {
 138     videos: {
 139       ofUsers: {
 140         enabled: boolean
 141       }
 142     }
 143   }
 144
 145   avatar: {
 146     file: {
 147       size: {
 148         max: number
 149       }
 150       extensions: string[]
 151     }
 152   }
 153
 154   banner: {
 155     file: {
 156       size: {
 157         max: number
 158       }
 159       extensions: string[]
 160     }
 161   }
 162
 163   video: {
 164     image: {
 165       size: {
 166         max: number
 167       }
 168       extensions: string[]
 169     }
 170     file: {
 171       extensions: string[]
 172     }
 173   }
 174
 175   videoCaption: {
 176     file: {
 177       size: {
 178         max: number
 179       }
 180       extensions: string[]
 181     }
 182   }
 183
 184   user: {
 185     videoQuota: number
 186     videoQuotaDaily: number
 187   }
 188
 189   trending: {
 190     videos: {
 191       intervalDays: number
 192       algorithms: {
 193         enabled: string[]
 194         default: string
 195       }
 196     }
 197   }
 198
 199   tracker: {
 200     enabled: boolean
 201   }
 202
 203   followings: {
 204     instance: {
 205       autoFollowIndex: {
 206         indexUrl: string
 207       }
 208     }
 209   }
 210
 211   broadcastMessage: {
 212     enabled: boolean
 213     message: string
 214     level: BroadcastMessageLevel
 215     dismissable: boolean
 216   }
 217
 218   homepage: {
 219     enabled: boolean
 220   }
 221 }
 222
 223 export type HTMLServerConfig = Omit<ServerConfig, 'signup'>