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   cache: {
  56     previews: {
  57       size: number
  58     }
  59
  60     captions: {
  61       size: number
  62     }
  63
  64     torrents: {
  65       size: number
  66     }
  67   }
  68
  69   signup: {
  70     enabled: boolean
  71     limit: number
  72     requiresEmailVerification: boolean
  73     minimumAge: number
  74   }
  75
  76   admin: {
  77     email: string
  78   }
  79
  80   contactForm: {
  81     enabled: boolean
  82   }
  83
  84   user: {
  85     videoQuota: number
  86     videoQuotaDaily: number
  87   }
  88
  89   videoChannels: {
  90     maxPerUser: number
  91   }
  92
  93   transcoding: {
  94     enabled: boolean
  95
  96     allowAdditionalExtensions: boolean
  97     allowAudioFiles: boolean
  98
  99     threads: number
 100     concurrency: number
 101
 102     profile: string
 103
 104     resolutions: ConfigResolutions & { '0p': boolean }
 105
 106     webtorrent: {
 107       enabled: boolean
 108     }
 109
 110     hls: {
 111       enabled: boolean
 112     }
 113   }
 114
 115   live: {
 116     enabled: boolean
 117
 118     allowReplay: boolean
 119
 120     maxDuration: number
 121     maxInstanceLives: number
 122     maxUserLives: number
 123
 124     transcoding: {
 125       enabled: boolean
 126       threads: number
 127       profile: string
 128       resolutions: ConfigResolutions
 129     }
 130   }
 131
 132   import: {
 133     videos: {
 134       concurrency: number
 135
 136       http: {
 137         enabled: boolean
 138       }
 139       torrent: {
 140         enabled: boolean
 141       }
 142     }
 143   }
 144
 145   trending: {
 146     videos: {
 147       algorithms: {
 148         enabled: string[]
 149         default: string
 150       }
 151     }
 152   }
 153
 154   autoBlacklist: {
 155     videos: {
 156       ofUsers: {
 157         enabled: boolean
 158       }
 159     }
 160   }
 161
 162   followers: {
 163     instance: {
 164       enabled: boolean
 165       manualApproval: boolean
 166     }
 167   }
 168
 169   followings: {
 170     instance: {
 171       autoFollowBack: {
 172         enabled: boolean
 173       }
 174
 175       autoFollowIndex: {
 176         enabled: boolean
 177         indexUrl: string
 178       }
 179     }
 180   }
 181
 182   broadcastMessage: {
 183     enabled: boolean
 184     message: string
 185     level: BroadcastMessageLevel
 186     dismissable: boolean
 187   }
 188
 189   search: {
 190     remoteUri: {
 191       users: boolean
 192       anonymous: boolean
 193     }
 194
 195     searchIndex: {
 196       enabled: boolean
 197       url: string
 198       disableLocalSearch: boolean
 199       isDefaultSearch: boolean
 200     }
 201   }
 202 }