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     defaultClientRoute: string
  40     isNSFW: boolean
  41     defaultNSFWPolicy: NSFWPolicyType
  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
 101   live: {
 102     enabled: boolean
 103
 104     maxDuration: number
 105     allowReplay: boolean
 106
 107     transcoding: {
 108       enabled: boolean
 109
 110       enabledResolutions: number[]
 111     }
 112   }
 113
 114   import: {
 115     videos: {
 116       http: {
 117         enabled: boolean
 118       }
 119       torrent: {
 120         enabled: boolean
 121       }
 122     }
 123   }
 124
 125   autoBlacklist: {
 126     videos: {
 127       ofUsers: {
 128         enabled: boolean
 129       }
 130     }
 131   }
 132
 133   avatar: {
 134     file: {
 135       size: {
 136         max: number
 137       }
 138       extensions: string[]
 139     }
 140   }
 141
 142   video: {
 143     image: {
 144       size: {
 145         max: number
 146       }
 147       extensions: string[]
 148     }
 149     file: {
 150       extensions: string[]
 151     }
 152   }
 153
 154   videoCaption: {
 155     file: {
 156       size: {
 157         max: number
 158       }
 159       extensions: string[]
 160     }
 161   }
 162
 163   user: {
 164     videoQuota: number
 165     videoQuotaDaily: number
 166   }
 167
 168   trending: {
 169     videos: {
 170       intervalDays: number
 171     }
 172   }
 173
 174   tracker: {
 175     enabled: boolean
 176   }
 177
 178   followings: {
 179     instance: {
 180       autoFollowIndex: {
 181         indexUrl: string
 182       }
 183     }
 184   }
 185
 186   broadcastMessage: {
 187     enabled: boolean
 188     message: string
 189     level: BroadcastMessageLevel
 190     dismissable: boolean
 191   }
 192 }