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     ROTATION: config.get<boolean>('log.rotation.enabled')
  88   },
  89   SEARCH: {
  90     REMOTE_URI: {
  91       USERS: config.get<boolean>('search.remote_uri.users'),
  92       ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous')
  93     }
  94   },
  95   TRENDING: {
  96     VIDEOS: {
  97       INTERVAL_DAYS: config.get<number>('trending.videos.interval_days')
  98     }
  99   },
 100   REDUNDANCY: {
 101     VIDEOS: {
 102       CHECK_INTERVAL: parseDurationToMs(config.get<string>('redundancy.videos.check_interval')),
 103       STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
 104     }
 105   },
 106   CSP: {
 107     ENABLED: config.get<boolean>('csp.enabled'),
 108     REPORT_ONLY: config.get<boolean>('csp.report_only'),
 109     REPORT_URI: config.get<boolean>('csp.report_uri')
 110   },
 111   TRACKER: {
 112     ENABLED: config.get<boolean>('tracker.enabled'),
 113     PRIVATE: config.get<boolean>('tracker.private'),
 114     REJECT_TOO_MANY_ANNOUNCES: config.get<boolean>('tracker.reject_too_many_announces')
 115   },
 116   HISTORY: {
 117     VIDEOS: {
 118       MAX_AGE: parseDurationToMs(config.get('history.videos.max_age'))
 119     }
 120   },
 121   VIEWS: {
 122     VIDEOS: {
 123       REMOTE: {
 124         MAX_AGE: parseDurationToMs(config.get('views.videos.remote.max_age'))
 125       }
 126     }
 127   },
 128   ADMIN: {
 129     get EMAIL () { return config.get<string>('admin.email') }
 130   },
 131   CONTACT_FORM: {
 132     get ENABLED () { return config.get<boolean>('contact_form.enabled') }
 133   },
 134   SIGNUP: {
 135     get ENABLED () { return config.get<boolean>('signup.enabled') },
 136     get LIMIT () { return config.get<number>('signup.limit') },
 137     get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
 138     FILTERS: {
 139       CIDR: {
 140         get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
 141         get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
 142       }
 143     }
 144   },
 145   USER: {
 146     get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
 147     get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
 148   },
 149   TRANSCODING: {
 150     get ENABLED () { return config.get<boolean>('transcoding.enabled') },
 151     get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
 152     get ALLOW_AUDIO_FILES () { return config.get<boolean>('transcoding.allow_audio_files') },
 153     get THREADS () { return config.get<number>('transcoding.threads') },
 154     RESOLUTIONS: {
 155       get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
 156       get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
 157       get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
 158       get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
 159       get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') },
 160       get '2160p' () { return config.get<boolean>('transcoding.resolutions.2160p') }
 161     },
 162     HLS: {
 163       get ENABLED () { return config.get<boolean>('transcoding.hls.enabled') }
 164     }
 165   },
 166   IMPORT: {
 167     VIDEOS: {
 168       HTTP: {
 169         get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
 170       },
 171       TORRENT: {
 172         get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
 173       }
 174     }
 175   },
 176   AUTO_BLACKLIST: {
 177     VIDEOS: {
 178       OF_USERS: {
 179         get ENABLED () { return config.get<boolean>('auto_blacklist.videos.of_users.enabled') }
 180       }
 181     }
 182   },
 183   CACHE: {
 184     PREVIEWS: {
 185       get SIZE () { return config.get<number>('cache.previews.size') }
 186     },
 187     VIDEO_CAPTIONS: {
 188       get SIZE () { return config.get<number>('cache.captions.size') }
 189     }
 190   },
 191   INSTANCE: {
 192     get NAME () { return config.get<string>('instance.name') },
 193     get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
 194     get DESCRIPTION () { return config.get<string>('instance.description') },
 195     get TERMS () { return config.get<string>('instance.terms') },
 196     get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
 197     get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
 198     get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
 199     CUSTOMIZATIONS: {
 200       get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
 201       get CSS () { return config.get<string>('instance.customizations.css') }
 202     },
 203     get ROBOTS () { return config.get<string>('instance.robots') },
 204     get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
 205     get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
 206   },
 207   SERVICES: {
 208     TWITTER: {
 209       get USERNAME () { return config.get<string>('services.twitter.username') },
 210       get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
 211     }
 212   },
 213   FOLLOWERS: {
 214     INSTANCE: {
 215       get ENABLED () { return config.get<boolean>('followers.instance.enabled') },
 216       get MANUAL_APPROVAL () { return config.get<boolean>('followers.instance.manual_approval') }
 217     }
 218   }
 219 }
 220
 221 function registerConfigChangedHandler (fun: Function) {
 222   configChangedHandlers.push(fun)
 223 }
 224
 225 // ---------------------------------------------------------------------------
 226
 227 export {
 228   CONFIG,
 229   registerConfigChangedHandler
 230 }
 231
 232 // ---------------------------------------------------------------------------
 233
 234 function getLocalConfigFilePath () {
 235   const configSources = config.util.getConfigSources()
 236   if (configSources.length === 0) throw new Error('Invalid config source.')
 237
 238   let filename = 'local'
 239   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 240   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 241
 242   return join(dirname(configSources[ 0 ].name), filename + '.json')
 243 }
 244
 245 function buildVideosRedundancy (objs: any[]): VideosRedundancy[] {
 246   if (!objs) return []
 247
 248   if (!Array.isArray(objs)) return objs
 249
 250   return objs.map(obj => {
 251     return Object.assign({}, obj, {
 252       minLifetime: parseDurationToMs(obj.min_lifetime),
 253       size: bytes.parse(obj.size),
 254       minViews: obj.min_views
 255     })
 256   })
 257 }
 258
 259 export function reloadConfig () {
 260
 261   function directory () {
 262     if (process.env.NODE_CONFIG_DIR) {
 263       return process.env.NODE_CONFIG_DIR
 264     }
 265
 266     return join(root(), 'config')
 267   }
 268
 269   function purge () {
 270     for (const fileName in require.cache) {
 271       if (-1 === fileName.indexOf(directory())) {
 272         continue
 273       }
 274
 275       delete require.cache[fileName]
 276     }
 277
 278     delete require.cache[require.resolve('config')]
 279   }
 280
 281   purge()
 282
 283   config = require('config')
 284
 285   for (const configChangedHandler of configChangedHandlers) {
 286     configChangedHandler()
 287   }
 288 }