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     requiresEmailVerification: boolean
  87     minimumAge: number
  88   }
  89
  90   admin: {
  91     email: string
  92   }
  93
  94   contactForm: {
  95     enabled: boolean
  96   }
  97
  98   user: {
  99     videoQuota: number
 100     videoQuotaDaily: number
 101   }
 102
 103   videoChannels: {
 104     maxPerUser: number
 105   }
 106
 107   transcoding: {
 108     enabled: boolean
 109
 110     allowAdditionalExtensions: boolean
 111     allowAudioFiles: boolean
 112
 113     threads: number
 114     concurrency: number
 115
 116     profile: string
 117
 118     resolutions: ConfigResolutions & { '0p': boolean }
 119
 120     alwaysTranscodeOriginalResolution: boolean
 121
 122     webtorrent: {
 123       enabled: boolean
 124     }
 125
 126     hls: {
 127       enabled: boolean
 128     }
 129   }
 130
 131   live: {
 132     enabled: boolean
 133
 134     allowReplay: boolean
 135
 136     latencySetting: {
 137       enabled: boolean
 138     }
 139
 140     maxDuration: number
 141     maxInstanceLives: number
 142     maxUserLives: number
 143
 144     transcoding: {
 145       enabled: boolean
 146       threads: number
 147       profile: string
 148       resolutions: ConfigResolutions
 149       alwaysTranscodeOriginalResolution: boolean
 150     }
 151   }
 152
 153   videoStudio: {
 154     enabled: boolean
 155   }
 156
 157   import: {
 158     videos: {
 159       concurrency: number
 160
 161       http: {
 162         enabled: boolean
 163       }
 164       torrent: {
 165         enabled: boolean
 166       }
 167     }
 168     videoChannelSynchronization: {
 169       enabled: boolean
 170       maxPerUser: number
 171     }
 172   }
 173
 174   trending: {
 175     videos: {
 176       algorithms: {
 177         enabled: string[]
 178         default: string
 179       }
 180     }
 181   }
 182
 183   autoBlacklist: {
 184     videos: {
 185       ofUsers: {
 186         enabled: boolean
 187       }
 188     }
 189   }
 190
 191   followers: {
 192     instance: {
 193       enabled: boolean
 194       manualApproval: boolean
 195     }
 196   }
 197
 198   followings: {
 199     instance: {
 200       autoFollowBack: {
 201         enabled: boolean
 202       }
 203
 204       autoFollowIndex: {
 205         enabled: boolean
 206         indexUrl: string
 207       }
 208     }
 209   }
 210
 211   broadcastMessage: {
 212     enabled: boolean
 213     message: string
 214     level: BroadcastMessageLevel
 215     dismissable: boolean
 216   }
 217
 218   search: {
 219     remoteUri: {
 220       users: boolean
 221       anonymous: boolean
 222     }
 223
 224     searchIndex: {
 225       enabled: boolean
 226       url: string
 227       disableLocalSearch: boolean
 228       isDefaultSearch: boolean
 229     }
 230   }
 231 }