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