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