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   '240p': boolean
   6   '360p': boolean
   7   '480p': boolean
   8   '720p': boolean
   9   '1080p': boolean
  10   '1440p': boolean
  11   '2160p': boolean
  12 }
  13
  14 export interface CustomConfig {
  15   instance: {
  16     name: string
  17     shortDescription: string
  18     description: string
  19     terms: string
  20     codeOfConduct: string
  21
  22     creationReason: string
  23     moderationInformation: string
  24     administrator: string
  25     maintenanceLifetime: string
  26     businessModel: string
  27     hardwareInformation: string
  28
  29     languages: string[]
  30     categories: number[]
  31
  32     isNSFW: boolean
  33     defaultNSFWPolicy: NSFWPolicyType
  34
  35     defaultClientRoute: string
  36
  37     customizations: {
  38       javascript?: string
  39       css?: string
  40     }
  41   }
  42
  43   theme: {
  44     default: string
  45   }
  46
  47   services: {
  48     twitter: {
  49       username: string
  50       whitelisted: boolean
  51     }
  52   }
  53
  54   cache: {
  55     previews: {
  56       size: number
  57     }
  58
  59     captions: {
  60       size: number
  61     }
  62   }
  63
  64   signup: {
  65     enabled: boolean
  66     limit: number
  67     requiresEmailVerification: boolean
  68   }
  69
  70   admin: {
  71     email: string
  72   }
  73
  74   contactForm: {
  75     enabled: boolean
  76   }
  77
  78   user: {
  79     videoQuota: number
  80     videoQuotaDaily: number
  81   }
  82
  83   transcoding: {
  84     enabled: boolean
  85
  86     allowAdditionalExtensions: boolean
  87     allowAudioFiles: boolean
  88
  89     threads: number
  90     resolutions: ConfigResolutions & { '0p': boolean }
  91
  92     webtorrent: {
  93       enabled: boolean
  94     }
  95
  96     hls: {
  97       enabled: boolean
  98     }
  99   }
 100
 101   live: {
 102     enabled: boolean
 103
 104     allowReplay: boolean
 105
 106     maxDuration: number
 107     maxInstanceLives: number
 108     maxUserLives: number
 109
 110     transcoding: {
 111       enabled: boolean
 112       threads: number
 113       resolutions: ConfigResolutions
 114     }
 115   }
 116
 117   import: {
 118     videos: {
 119       http: {
 120         enabled: boolean
 121       }
 122       torrent: {
 123         enabled: boolean
 124       }
 125     }
 126   }
 127
 128   trending: {
 129     videos: {
 130       algorithms: {
 131         enabled: string[]
 132         default: string
 133       }
 134     }
 135   }
 136
 137   autoBlacklist: {
 138     videos: {
 139       ofUsers: {
 140         enabled: boolean
 141       }
 142     }
 143   }
 144
 145   followers: {
 146     instance: {
 147       enabled: boolean
 148       manualApproval: boolean
 149     }
 150   }
 151
 152   followings: {
 153     instance: {
 154       autoFollowBack: {
 155         enabled: boolean
 156       }
 157
 158       autoFollowIndex: {
 159         enabled: boolean
 160         indexUrl: string
 161       }
 162     }
 163   }
 164
 165   broadcastMessage: {
 166     enabled: boolean
 167     message: string
 168     level: BroadcastMessageLevel
 169     dismissable: boolean
 170   }
 171
 172   search: {
 173     remoteUri: {
 174       users: boolean
 175       anonymous: boolean
 176     }
 177
 178     searchIndex: {
 179       enabled: boolean
 180       url: string
 181       disableLocalSearch: boolean
 182       isDefaultSearch: boolean
 183     }
 184   }
 185 }