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