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