shared/models/server/server-config.model.ts

   1 import { VideoPrivacy } from '../videos/video-privacy.enum'
   2 import { ClientScriptJSON } from '../plugins/plugin-package-json.model'
   3 import { NSFWPolicyType } from '../videos/nsfw-policy.type'
   4 import { BroadcastMessageLevel } from './broadcast-message-level.type'
   5
   6 export interface ServerConfigPlugin {
   7   name: string
   8   npmName: string
   9   version: string
  10   description: string
  11   clientScripts: { [name: string]: ClientScriptJSON }
  12 }
  13
  14 export interface ServerConfigTheme extends ServerConfigPlugin {
  15   css: string[]
  16 }
  17
  18 export interface RegisteredExternalAuthConfig {
  19   npmName: string
  20   name: string
  21   version: string
  22   authName: string
  23   authDisplayName: string
  24 }
  25
  26 export interface RegisteredIdAndPassAuthConfig {
  27   npmName: string
  28   name: string
  29   version: string
  30   authName: string
  31   weight: number
  32 }
  33
  34 export interface ServerConfig {
  35   serverVersion: string
  36   serverCommit?: string
  37
  38   client: {
  39     videos: {
  40       miniature: {
  41         preferAuthorDisplayName: boolean
  42       }
  43     }
  44
  45     menu: {
  46       login: {
  47         redirectOnSingleExternalAuth: boolean
  48       }
  49     }
  50   }
  51
  52   defaults: {
  53     publish: {
  54       downloadEnabled: boolean
  55       commentsEnabled: boolean
  56       privacy: VideoPrivacy
  57       licence: number
  58     }
  59
  60     p2p: {
  61       webapp: {
  62         enabled: boolean
  63       }
  64
  65       embed: {
  66         enabled: boolean
  67       }
  68     }
  69   }
  70
  71   webadmin: {
  72     configuration: {
  73       edition: {
  74         allowed: boolean
  75       }
  76     }
  77   }
  78
  79   instance: {
  80     name: string
  81     shortDescription: string
  82     isNSFW: boolean
  83     defaultNSFWPolicy: NSFWPolicyType
  84     defaultClientRoute: string
  85     customizations: {
  86       javascript: string
  87       css: string
  88     }
  89   }
  90
  91   search: {
  92     remoteUri: {
  93       users: boolean
  94       anonymous: boolean
  95     }
  96
  97     searchIndex: {
  98       enabled: boolean
  99       url: string
 100       disableLocalSearch: boolean
 101       isDefaultSearch: boolean
 102     }
 103   }
 104
 105   plugin: {
 106     registered: ServerConfigPlugin[]
 107
 108     registeredExternalAuths: RegisteredExternalAuthConfig[]
 109
 110     registeredIdAndPassAuths: RegisteredIdAndPassAuthConfig[]
 111   }
 112
 113   theme: {
 114     registered: ServerConfigTheme[]
 115     default: string
 116   }
 117
 118   email: {
 119     enabled: boolean
 120   }
 121
 122   contactForm: {
 123     enabled: boolean
 124   }
 125
 126   signup: {
 127     allowed: boolean
 128     allowedForCurrentIP: boolean
 129     requiresEmailVerification: boolean
 130     minimumAge: number
 131   }
 132
 133   transcoding: {
 134     hls: {
 135       enabled: boolean
 136     }
 137
 138     webtorrent: {
 139       enabled: boolean
 140     }
 141
 142     enabledResolutions: number[]
 143
 144     profile: string
 145     availableProfiles: string[]
 146   }
 147
 148   live: {
 149     enabled: boolean
 150
 151     maxDuration: number
 152     maxInstanceLives: number
 153     maxUserLives: number
 154     allowReplay: boolean
 155
 156     transcoding: {
 157       enabled: boolean
 158
 159       enabledResolutions: number[]
 160
 161       profile: string
 162       availableProfiles: string[]
 163     }
 164
 165     rtmp: {
 166       port: number
 167     }
 168   }
 169
 170   videoEditor: {
 171     enabled: boolean
 172   }
 173
 174   import: {
 175     videos: {
 176       http: {
 177         enabled: boolean
 178       }
 179       torrent: {
 180         enabled: boolean
 181       }
 182     }
 183   }
 184
 185   autoBlacklist: {
 186     videos: {
 187       ofUsers: {
 188         enabled: boolean
 189       }
 190     }
 191   }
 192
 193   avatar: {
 194     file: {
 195       size: {
 196         max: number
 197       }
 198       extensions: string[]
 199     }
 200   }
 201
 202   banner: {
 203     file: {
 204       size: {
 205         max: number
 206       }
 207       extensions: string[]
 208     }
 209   }
 210
 211   video: {
 212     image: {
 213       size: {
 214         max: number
 215       }
 216       extensions: string[]
 217     }
 218     file: {
 219       extensions: string[]
 220     }
 221   }
 222
 223   videoCaption: {
 224     file: {
 225       size: {
 226         max: number
 227       }
 228       extensions: string[]
 229     }
 230   }
 231
 232   user: {
 233     videoQuota: number
 234     videoQuotaDaily: number
 235   }
 236
 237   videoChannels: {
 238     maxPerUser: number
 239   }
 240
 241   trending: {
 242     videos: {
 243       intervalDays: number
 244       algorithms: {
 245         enabled: string[]
 246         default: string
 247       }
 248     }
 249   }
 250
 251   tracker: {
 252     enabled: boolean
 253   }
 254
 255   followings: {
 256     instance: {
 257       autoFollowIndex: {
 258         indexUrl: string
 259       }
 260     }
 261   }
 262
 263   broadcastMessage: {
 264     enabled: boolean
 265     message: string
 266     level: BroadcastMessageLevel
 267     dismissable: boolean
 268   }
 269
 270   homepage: {
 271     enabled: boolean
 272   }
 273 }
 274
 275 export type HTMLServerConfig = Omit<ServerConfig, 'signup'>