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