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