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

   1 import { NSFWPolicyType } from '../videos/nsfw-policy.type'
   2 import { BroadcastMessageLevel } from './broadcast-message-level.type'
   3
   4 export type ConfigResolutions = {
   5   '144p': boolean
   6   '240p': boolean
   7   '360p': boolean
   8   '480p': boolean
   9   '720p': boolean
  10   '1080p': boolean
  11   '1440p': boolean
  12   '2160p': boolean
  13 }
  14
  15 export interface CustomConfig {
  16   instance: {
  17     name: string
  18     shortDescription: string
  19     description: string
  20     terms: string
  21     codeOfConduct: string
  22
  23     creationReason: string
  24     moderationInformation: string
  25     administrator: string
  26     maintenanceLifetime: string
  27     businessModel: string
  28     hardwareInformation: string
  29
  30     languages: string[]
  31     categories: number[]
  32
  33     isNSFW: boolean
  34     defaultNSFWPolicy: NSFWPolicyType
  35
  36     defaultClientRoute: string
  37
  38     customizations: {
  39       javascript?: string
  40       css?: string
  41     }
  42   }
  43
  44   theme: {
  45     default: string
  46   }
  47
  48   services: {
  49     twitter: {
  50       username: string
  51       whitelisted: boolean
  52     }
  53   }
  54
  55   client: {
  56     videos: {
  57       miniature: {
  58         preferAuthorDisplayName: boolean
  59       }
  60     }
  61
  62     menu: {
  63       login: {
  64         redirectOnSingleExternalAuth: boolean
  65       }
  66     }
  67   }
  68
  69   cache: {
  70     previews: {
  71       size: number
  72     }
  73
  74     captions: {
  75       size: number
  76     }
  77
  78     torrents: {
  79       size: number
  80     }
  81   }
  82
  83   signup: {
  84     enabled: boolean
  85     limit: number
  86     requiresApproval: boolean
  87     requiresEmailVerification: boolean
  88     minimumAge: number
  89   }
  90
  91   admin: {
  92     email: string
  93   }
  94
  95   contactForm: {
  96     enabled: boolean
  97   }
  98
  99   user: {
 100     history: {
 101       videos: {
 102         enabled: boolean
 103       }
 104     }
 105     videoQuota: number
 106     videoQuotaDaily: number
 107   }
 108
 109   videoChannels: {
 110     maxPerUser: number
 111   }
 112
 113   transcoding: {
 114     enabled: boolean
 115
 116     allowAdditionalExtensions: boolean
 117     allowAudioFiles: boolean
 118
 119     remoteRunners: {
 120       enabled: boolean
 121     }
 122
 123     threads: number
 124     concurrency: number
 125
 126     profile: string
 127
 128     resolutions: ConfigResolutions & { '0p': boolean }
 129
 130     alwaysTranscodeOriginalResolution: boolean
 131
 132     webtorrent: {
 133       enabled: boolean
 134     }
 135
 136     hls: {
 137       enabled: boolean
 138     }
 139   }
 140
 141   live: {
 142     enabled: boolean
 143
 144     allowReplay: boolean
 145
 146     latencySetting: {
 147       enabled: boolean
 148     }
 149
 150     maxDuration: number
 151     maxInstanceLives: number
 152     maxUserLives: number
 153
 154     transcoding: {
 155       enabled: boolean
 156       remoteRunners: {
 157         enabled: boolean
 158       }
 159       threads: number
 160       profile: string
 161       resolutions: ConfigResolutions
 162       alwaysTranscodeOriginalResolution: boolean
 163     }
 164   }
 165
 166   videoStudio: {
 167     enabled: boolean
 168   }
 169
 170   import: {
 171     videos: {
 172       concurrency: number
 173
 174       http: {
 175         enabled: boolean
 176       }
 177       torrent: {
 178         enabled: boolean
 179       }
 180     }
 181     videoChannelSynchronization: {
 182       enabled: boolean
 183       maxPerUser: number
 184     }
 185   }
 186
 187   trending: {
 188     videos: {
 189       algorithms: {
 190         enabled: string[]
 191         default: string
 192       }
 193     }
 194   }
 195
 196   autoBlacklist: {
 197     videos: {
 198       ofUsers: {
 199         enabled: boolean
 200       }
 201     }
 202   }
 203
 204   followers: {
 205     instance: {
 206       enabled: boolean
 207       manualApproval: boolean
 208     }
 209   }
 210
 211   followings: {
 212     instance: {
 213       autoFollowBack: {
 214         enabled: boolean
 215       }
 216
 217       autoFollowIndex: {
 218         enabled: boolean
 219         indexUrl: string
 220       }
 221     }
 222   }
 223
 224   broadcastMessage: {
 225     enabled: boolean
 226     message: string
 227     level: BroadcastMessageLevel
 228     dismissable: boolean
 229   }
 230
 231   search: {
 232     remoteUri: {
 233       users: boolean
 234       anonymous: boolean
 235     }
 236
 237     searchIndex: {
 238       enabled: boolean
 239       url: string
 240       disableLocalSearch: boolean
 241       isDefaultSearch: boolean
 242     }
 243   }
 244
 245 }