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     concurrency: number
  91
  92     profile: string
  93
  94     resolutions: ConfigResolutions & { '0p': boolean }
  95
  96     webtorrent: {
  97       enabled: boolean
  98     }
  99
 100     hls: {
 101       enabled: boolean
 102     }
 103   }
 104
 105   live: {
 106     enabled: boolean
 107
 108     allowReplay: boolean
 109
 110     maxDuration: number
 111     maxInstanceLives: number
 112     maxUserLives: number
 113
 114     transcoding: {
 115       enabled: boolean
 116       threads: number
 117       profile: string
 118       resolutions: ConfigResolutions
 119     }
 120   }
 121
 122   import: {
 123     videos: {
 124       concurrency: number
 125
 126       http: {
 127         enabled: boolean
 128       }
 129       torrent: {
 130         enabled: boolean
 131       }
 132     }
 133   }
 134
 135   trending: {
 136     videos: {
 137       algorithms: {
 138         enabled: string[]
 139         default: string
 140       }
 141     }
 142   }
 143
 144   autoBlacklist: {
 145     videos: {
 146       ofUsers: {
 147         enabled: boolean
 148       }
 149     }
 150   }
 151
 152   followers: {
 153     instance: {
 154       enabled: boolean
 155       manualApproval: boolean
 156     }
 157   }
 158
 159   followings: {
 160     instance: {
 161       autoFollowBack: {
 162         enabled: boolean
 163       }
 164
 165       autoFollowIndex: {
 166         enabled: boolean
 167         indexUrl: string
 168       }
 169     }
 170   }
 171
 172   broadcastMessage: {
 173     enabled: boolean
 174     message: string
 175     level: BroadcastMessageLevel
 176     dismissable: boolean
 177   }
 178
 179   search: {
 180     remoteUri: {
 181       users: boolean
 182       anonymous: boolean
 183     }
 184
 185     searchIndex: {
 186       enabled: boolean
 187       url: string
 188       disableLocalSearch: boolean
 189       isDefaultSearch: boolean
 190     }
 191   }
 192 }