server/initializers/config.ts

   1 import { IConfig } from 'config'
   2 import { dirname, join } from 'path'
   3 import { VideosRedundancy } from '../../shared/models'
   4 // Do not use barrels, remain constants as independent as possible
   5 import { buildPath, parseBytes, parseDurationToMs, root } from '../helpers/core-utils'
   6 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
   7 import * as bytes from 'bytes'
   8
   9 // Use a variable to reload the configuration if we need
  10 let config: IConfig = require('config')
  11
  12 const configChangedHandlers: Function[] = []
  13
  14 const CONFIG = {
  15   CUSTOM_FILE: getLocalConfigFilePath(),
  16   LISTEN: {
  17     PORT: config.get<number>('listen.port'),
  18     HOSTNAME: config.get<string>('listen.hostname')
  19   },
  20   DATABASE: {
  21     DBNAME: 'peertube' + config.get<string>('database.suffix'),
  22     HOSTNAME: config.get<string>('database.hostname'),
  23     PORT: config.get<number>('database.port'),
  24     USERNAME: config.get<string>('database.username'),
  25     PASSWORD: config.get<string>('database.password'),
  26     POOL: {
  27       MAX: config.get<number>('database.pool.max')
  28     }
  29   },
  30   REDIS: {
  31     HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
  32     PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
  33     SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
  34     AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
  35     DB: config.has('redis.db') ? config.get<number>('redis.db') : null
  36   },
  37   SMTP: {
  38     HOSTNAME: config.get<string>('smtp.hostname'),
  39     PORT: config.get<number>('smtp.port'),
  40     USERNAME: config.get<string>('smtp.username'),
  41     PASSWORD: config.get<string>('smtp.password'),
  42     TLS: config.get<boolean>('smtp.tls'),
  43     DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
  44     CA_FILE: config.get<string>('smtp.ca_file'),
  45     FROM_ADDRESS: config.get<string>('smtp.from_address')
  46   },
  47   EMAIL: {
  48     BODY: {
  49       SIGNATURE: config.get<string>('email.body.signature')
  50     },
  51     OBJECT: {
  52       PREFIX: config.get<string>('email.object.prefix') + ' '
  53     }
  54   },
  55   STORAGE: {
  56     TMP_DIR: buildPath(config.get<string>('storage.tmp')),
  57     AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
  58     LOG_DIR: buildPath(config.get<string>('storage.logs')),
  59     VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
  60     STREAMING_PLAYLISTS_DIR: buildPath(config.get<string>('storage.streaming_playlists')),
  61     REDUNDANCY_DIR: buildPath(config.get<string>('storage.redundancy')),
  62     THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
  63     PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
  64     CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
  65     TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
  66     CACHE_DIR: buildPath(config.get<string>('storage.cache'))
  67   },
  68   WEBSERVER: {
  69     SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
  70     WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
  71     HOSTNAME: config.get<string>('webserver.hostname'),
  72     PORT: config.get<number>('webserver.port')
  73   },
  74   RATES_LIMIT: {
  75     LOGIN: {
  76       WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.login.window')),
  77       MAX: config.get<number>('rates_limit.login.max')
  78     },
  79     ASK_SEND_EMAIL: {
  80       WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.ask_send_email.window')),
  81       MAX: config.get<number>('rates_limit.ask_send_email.max')
  82     }
  83   },
  84   TRUST_PROXY: config.get<string[]>('trust_proxy'),
  85   LOG: {
  86     LEVEL: config.get<string>('log.level')
  87   },
  88   SEARCH: {
  89     REMOTE_URI: {
  90       USERS: config.get<boolean>('search.remote_uri.users'),
  91       ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous')
  92     }
  93   },
  94   TRENDING: {
  95     VIDEOS: {
  96       INTERVAL_DAYS: config.get<number>('trending.videos.interval_days')
  97     }
  98   },
  99   REDUNDANCY: {
 100     VIDEOS: {
 101       CHECK_INTERVAL: parseDurationToMs(config.get<string>('redundancy.videos.check_interval')),
 102       STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
 103     }
 104   },
 105   CSP: {
 106     ENABLED: config.get<boolean>('csp.enabled'),
 107     REPORT_ONLY: config.get<boolean>('csp.report_only'),
 108     REPORT_URI: config.get<boolean>('csp.report_uri')
 109   },
 110   TRACKER: {
 111     ENABLED: config.get<boolean>('tracker.enabled'),
 112     PRIVATE: config.get<boolean>('tracker.private'),
 113     REJECT_TOO_MANY_ANNOUNCES: config.get<boolean>('tracker.reject_too_many_announces')
 114   },
 115   HISTORY: {
 116     VIDEOS: {
 117       MAX_AGE: parseDurationToMs(config.get('history.videos.max_age'))
 118     }
 119   },
 120   VIEWS: {
 121     VIDEOS: {
 122       REMOTE: {
 123         MAX_AGE: parseDurationToMs(config.get('views.videos.remote.max_age'))
 124       }
 125     }
 126   },
 127   ADMIN: {
 128     get EMAIL () { return config.get<string>('admin.email') }
 129   },
 130   CONTACT_FORM: {
 131     get ENABLED () { return config.get<boolean>('contact_form.enabled') }
 132   },
 133   SIGNUP: {
 134     get ENABLED () { return config.get<boolean>('signup.enabled') },
 135     get LIMIT () { return config.get<number>('signup.limit') },
 136     get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
 137     FILTERS: {
 138       CIDR: {
 139         get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
 140         get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
 141       }
 142     }
 143   },
 144   USER: {
 145     get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
 146     get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
 147   },
 148   TRANSCODING: {
 149     get ENABLED () { return config.get<boolean>('transcoding.enabled') },
 150     get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
 151     get ALLOW_AUDIO_FILES () { return config.get<boolean>('transcoding.allow_audio_files') },
 152     get THREADS () { return config.get<number>('transcoding.threads') },
 153     RESOLUTIONS: {
 154       get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
 155       get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
 156       get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
 157       get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
 158       get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
 159     },
 160     HLS: {
 161       get ENABLED () { return config.get<boolean>('transcoding.hls.enabled') }
 162     }
 163   },
 164   IMPORT: {
 165     VIDEOS: {
 166       HTTP: {
 167         get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
 168       },
 169       TORRENT: {
 170         get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
 171       }
 172     }
 173   },
 174   AUTO_BLACKLIST: {
 175     VIDEOS: {
 176       OF_USERS: {
 177         get ENABLED () { return config.get<boolean>('auto_blacklist.videos.of_users.enabled') }
 178       }
 179     }
 180   },
 181   CACHE: {
 182     PREVIEWS: {
 183       get SIZE () { return config.get<number>('cache.previews.size') }
 184     },
 185     VIDEO_CAPTIONS: {
 186       get SIZE () { return config.get<number>('cache.captions.size') }
 187     }
 188   },
 189   INSTANCE: {
 190     get NAME () { return config.get<string>('instance.name') },
 191     get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
 192     get DESCRIPTION () { return config.get<string>('instance.description') },
 193     get TERMS () { return config.get<string>('instance.terms') },
 194     get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
 195     get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
 196     get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
 197     CUSTOMIZATIONS: {
 198       get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
 199       get CSS () { return config.get<string>('instance.customizations.css') }
 200     },
 201     get ROBOTS () { return config.get<string>('instance.robots') },
 202     get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
 203     get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
 204   },
 205   SERVICES: {
 206     TWITTER: {
 207       get USERNAME () { return config.get<string>('services.twitter.username') },
 208       get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
 209     }
 210   },
 211   FOLLOWERS: {
 212     INSTANCE: {
 213       get ENABLED () { return config.get<boolean>('followers.instance.enabled') },
 214       get MANUAL_APPROVAL () { return config.get<boolean>('followers.instance.manual_approval') }
 215     }
 216   }
 217 }
 218
 219 function registerConfigChangedHandler (fun: Function) {
 220   configChangedHandlers.push(fun)
 221 }
 222
 223 // ---------------------------------------------------------------------------
 224
 225 export {
 226   CONFIG,
 227   registerConfigChangedHandler
 228 }
 229
 230 // ---------------------------------------------------------------------------
 231
 232 function getLocalConfigFilePath () {
 233   const configSources = config.util.getConfigSources()
 234   if (configSources.length === 0) throw new Error('Invalid config source.')
 235
 236   let filename = 'local'
 237   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 238   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 239
 240   return join(dirname(configSources[ 0 ].name), filename + '.json')
 241 }
 242
 243 function buildVideosRedundancy (objs: any[]): VideosRedundancy[] {
 244   if (!objs) return []
 245
 246   if (!Array.isArray(objs)) return objs
 247
 248   return objs.map(obj => {
 249     return Object.assign({}, obj, {
 250       minLifetime: parseDurationToMs(obj.min_lifetime),
 251       size: bytes.parse(obj.size),
 252       minViews: obj.min_views
 253     })
 254   })
 255 }
 256
 257 export function reloadConfig () {
 258
 259   function directory () {
 260     if (process.env.NODE_CONFIG_DIR) {
 261       return process.env.NODE_CONFIG_DIR
 262     }
 263
 264     return join(root(), 'config')
 265   }
 266
 267   function purge () {
 268     for (const fileName in require.cache) {
 269       if (-1 === fileName.indexOf(directory())) {
 270         continue
 271       }
 272
 273       delete require.cache[fileName]
 274     }
 275
 276     delete require.cache[require.resolve('config')]
 277   }
 278
 279   purge()
 280
 281   config = require('config')
 282
 283   for (const configChangedHandler of configChangedHandlers) {
 284     configChangedHandler()
 285   }
 286 }