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     defaultTrendingRoute: string
  37     pages: {
  38       hot: {
  39         enabled: boolean
  40       }
  41     }
  42
  43     customizations: {
  44       javascript?: string
  45       css?: string
  46     }
  47   }
  48
  49   theme: {
  50     default: string
  51   }
  52
  53   services: {
  54     twitter: {
  55       username: string
  56       whitelisted: boolean
  57     }
  58   }
  59
  60   cache: {
  61     previews: {
  62       size: number
  63     }
  64
  65     captions: {
  66       size: number
  67     }
  68   }
  69
  70   signup: {
  71     enabled: boolean
  72     limit: number
  73     requiresEmailVerification: boolean
  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   transcoding: {
  90     enabled: boolean
  91
  92     allowAdditionalExtensions: boolean
  93     allowAudioFiles: boolean
  94
  95     threads: number
  96     resolutions: ConfigResolutions & { '0p': boolean }
  97
  98     webtorrent: {
  99       enabled: boolean
 100     }
 101
 102     hls: {
 103       enabled: boolean
 104     }
 105   }
 106
 107   live: {
 108     enabled: boolean
 109
 110     allowReplay: boolean
 111
 112     maxDuration: number
 113     maxInstanceLives: number
 114     maxUserLives: number
 115
 116     transcoding: {
 117       enabled: boolean
 118       threads: number
 119       resolutions: ConfigResolutions
 120     }
 121   }
 122
 123   import: {
 124     videos: {
 125       http: {
 126         enabled: boolean
 127       }
 128       torrent: {
 129         enabled: boolean
 130       }
 131     }
 132   }
 133
 134   autoBlacklist: {
 135     videos: {
 136       ofUsers: {
 137         enabled: boolean
 138       }
 139     }
 140   }
 141
 142   followers: {
 143     instance: {
 144       enabled: boolean
 145       manualApproval: boolean
 146     }
 147   }
 148
 149   followings: {
 150     instance: {
 151       autoFollowBack: {
 152         enabled: boolean
 153       }
 154
 155       autoFollowIndex: {
 156         enabled: boolean
 157         indexUrl: string
 158       }
 159     }
 160   }
 161
 162   broadcastMessage: {
 163     enabled: boolean
 164     message: string
 165     level: BroadcastMessageLevel
 166     dismissable: boolean
 167   }
 168
 169   search: {
 170     remoteUri: {
 171       users: boolean
 172       anonymous: boolean
 173     }
 174
 175     searchIndex: {
 176       enabled: boolean
 177       url: string
 178       disableLocalSearch: boolean
 179       isDefaultSearch: boolean
 180     }
 181   }
 182 }