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     defaultTrendingRoute: string
  43     pages: {
  44       hot: {
  45         enabled: boolean
  46       }
  47     }
  48     customizations: {
  49       javascript: string
  50       css: string
  51     }
  52   }
  53
  54   search: {
  55     remoteUri: {
  56       users: boolean
  57       anonymous: boolean
  58     }
  59
  60     searchIndex: {
  61       enabled: boolean
  62       url: string
  63       disableLocalSearch: boolean
  64       isDefaultSearch: boolean
  65     }
  66   }
  67
  68   plugin: {
  69     registered: ServerConfigPlugin[]
  70
  71     registeredExternalAuths: RegisteredExternalAuthConfig[]
  72
  73     registeredIdAndPassAuths: RegisteredIdAndPassAuthConfig[]
  74   }
  75
  76   theme: {
  77     registered: ServerConfigTheme[]
  78     default: string
  79   }
  80
  81   email: {
  82     enabled: boolean
  83   }
  84
  85   contactForm: {
  86     enabled: boolean
  87   }
  88
  89   signup: {
  90     allowed: boolean
  91     allowedForCurrentIP: boolean
  92     requiresEmailVerification: boolean
  93   }
  94
  95   transcoding: {
  96     hls: {
  97       enabled: boolean
  98     }
  99
 100     webtorrent: {
 101       enabled: boolean
 102     }
 103
 104     enabledResolutions: number[]
 105   }
 106
 107   live: {
 108     enabled: boolean
 109
 110     maxDuration: number
 111     maxInstanceLives: number
 112     maxUserLives: number
 113     allowReplay: boolean
 114
 115     transcoding: {
 116       enabled: boolean
 117
 118       enabledResolutions: number[]
 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   video: {
 155     image: {
 156       size: {
 157         max: number
 158       }
 159       extensions: string[]
 160     }
 161     file: {
 162       extensions: string[]
 163     }
 164   }
 165
 166   videoCaption: {
 167     file: {
 168       size: {
 169         max: number
 170       }
 171       extensions: string[]
 172     }
 173   }
 174
 175   user: {
 176     videoQuota: number
 177     videoQuotaDaily: number
 178   }
 179
 180   trending: {
 181     videos: {
 182       intervalDays: number
 183     }
 184   }
 185
 186   tracker: {
 187     enabled: boolean
 188   }
 189
 190   followings: {
 191     instance: {
 192       autoFollowIndex: {
 193         indexUrl: string
 194       }
 195     }
 196   }
 197
 198   broadcastMessage: {
 199     enabled: boolean
 200     message: string
 201     level: BroadcastMessageLevel
 202     dismissable: boolean
 203   }
 204 }