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     SUBJECT: {
  52       PREFIX: config.get<string>('email.subject.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     PLUGINS_DIR: buildPath(config.get<string>('storage.plugins'))
  68   },
  69   WEBSERVER: {
  70     SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
  71     WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
  72     HOSTNAME: config.get<string>('webserver.hostname'),
  73     PORT: config.get<number>('webserver.port')
  74   },
  75   RATES_LIMIT: {
  76     API: {
  77       WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.api.window')),
  78       MAX: config.get<number>('rates_limit.api.max')
  79     },
  80     SIGNUP: {
  81       WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.signup.window')),
  82       MAX: config.get<number>('rates_limit.signup.max')
  83     },
  84     LOGIN: {
  85       WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.login.window')),
  86       MAX: config.get<number>('rates_limit.login.max')
  87     },
  88     ASK_SEND_EMAIL: {
  89       WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.ask_send_email.window')),
  90       MAX: config.get<number>('rates_limit.ask_send_email.max')
  91     }
  92   },
  93   TRUST_PROXY: config.get<string[]>('trust_proxy'),
  94   LOG: {
  95     LEVEL: config.get<string>('log.level'),
  96     ROTATION: config.get<boolean>('log.rotation.enabled')
  97   },
  98   SEARCH: {
  99     REMOTE_URI: {
 100       USERS: config.get<boolean>('search.remote_uri.users'),
 101       ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous')
 102     }
 103   },
 104   TRENDING: {
 105     VIDEOS: {
 106       INTERVAL_DAYS: config.get<number>('trending.videos.interval_days')
 107     }
 108   },
 109   REDUNDANCY: {
 110     VIDEOS: {
 111       CHECK_INTERVAL: parseDurationToMs(config.get<string>('redundancy.videos.check_interval')),
 112       STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
 113     }
 114   },
 115   CSP: {
 116     ENABLED: config.get<boolean>('csp.enabled'),
 117     REPORT_ONLY: config.get<boolean>('csp.report_only'),
 118     REPORT_URI: config.get<boolean>('csp.report_uri')
 119   },
 120   TRACKER: {
 121     ENABLED: config.get<boolean>('tracker.enabled'),
 122     PRIVATE: config.get<boolean>('tracker.private'),
 123     REJECT_TOO_MANY_ANNOUNCES: config.get<boolean>('tracker.reject_too_many_announces')
 124   },
 125   HISTORY: {
 126     VIDEOS: {
 127       MAX_AGE: parseDurationToMs(config.get('history.videos.max_age'))
 128     }
 129   },
 130   VIEWS: {
 131     VIDEOS: {
 132       REMOTE: {
 133         MAX_AGE: parseDurationToMs(config.get('views.videos.remote.max_age'))
 134       }
 135     }
 136   },
 137   PLUGINS: {
 138     INDEX: {
 139       ENABLED: config.get<boolean>('plugins.index.enabled'),
 140       CHECK_LATEST_VERSIONS_INTERVAL: parseDurationToMs(config.get<string>('plugins.index.check_latest_versions_interval')),
 141       URL: config.get<string>('plugins.index.url')
 142     }
 143   },
 144   ADMIN: {
 145     get EMAIL () { return config.get<string>('admin.email') }
 146   },
 147   CONTACT_FORM: {
 148     get ENABLED () { return config.get<boolean>('contact_form.enabled') }
 149   },
 150   SIGNUP: {
 151     get ENABLED () { return config.get<boolean>('signup.enabled') },
 152     get LIMIT () { return config.get<number>('signup.limit') },
 153     get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
 154     FILTERS: {
 155       CIDR: {
 156         get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
 157         get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
 158       }
 159     }
 160   },
 161   USER: {
 162     get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
 163     get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
 164   },
 165   TRANSCODING: {
 166     get ENABLED () { return config.get<boolean>('transcoding.enabled') },
 167     get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
 168     get ALLOW_AUDIO_FILES () { return config.get<boolean>('transcoding.allow_audio_files') },
 169     get THREADS () { return config.get<number>('transcoding.threads') },
 170     RESOLUTIONS: {
 171       get '0p' () { return config.get<boolean>('transcoding.resolutions.0p') },
 172       get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
 173       get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
 174       get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
 175       get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
 176       get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') },
 177       get '2160p' () { return config.get<boolean>('transcoding.resolutions.2160p') }
 178     },
 179     HLS: {
 180       get ENABLED () { return config.get<boolean>('transcoding.hls.enabled') }
 181     },
 182     WEBTORRENT: {
 183       get ENABLED () { return config.get<boolean>('transcoding.webtorrent.enabled') }
 184     }
 185   },
 186   IMPORT: {
 187     VIDEOS: {
 188       HTTP: {
 189         get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
 190       },
 191       TORRENT: {
 192         get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
 193       }
 194     }
 195   },
 196   AUTO_BLACKLIST: {
 197     VIDEOS: {
 198       OF_USERS: {
 199         get ENABLED () { return config.get<boolean>('auto_blacklist.videos.of_users.enabled') }
 200       }
 201     }
 202   },
 203   CACHE: {
 204     PREVIEWS: {
 205       get SIZE () { return config.get<number>('cache.previews.size') }
 206     },
 207     VIDEO_CAPTIONS: {
 208       get SIZE () { return config.get<number>('cache.captions.size') }
 209     }
 210   },
 211   INSTANCE: {
 212     get NAME () { return config.get<string>('instance.name') },
 213     get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
 214     get DESCRIPTION () { return config.get<string>('instance.description') },
 215     get TERMS () { return config.get<string>('instance.terms') },
 216     get CODE_OF_CONDUCT () { return config.get<string>('instance.code_of_conduct') },
 217
 218     get CREATION_REASON () { return config.get<string>('instance.creation_reason') },
 219
 220     get MODERATION_INFORMATION () { return config.get<string>('instance.moderation_information') },
 221     get ADMINISTRATOR () { return config.get<string>('instance.administrator') },
 222     get MAINTENANCE_LIFETIME () { return config.get<string>('instance.maintenance_lifetime') },
 223     get BUSINESS_MODEL () { return config.get<string>('instance.business_model') },
 224     get HARDWARE_INFORMATION () { return config.get<string>('instance.hardware_information') },
 225
 226     get LANGUAGES () { return config.get<string[]>('instance.languages') || [] },
 227     get CATEGORIES () { return config.get<number[]>('instance.categories') || [] },
 228
 229     get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
 230     get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
 231     get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
 232     CUSTOMIZATIONS: {
 233       get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
 234       get CSS () { return config.get<string>('instance.customizations.css') }
 235     },
 236     get ROBOTS () { return config.get<string>('instance.robots') },
 237     get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
 238     get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
 239   },
 240   SERVICES: {
 241     TWITTER: {
 242       get USERNAME () { return config.get<string>('services.twitter.username') },
 243       get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
 244     }
 245   },
 246   FOLLOWERS: {
 247     INSTANCE: {
 248       get ENABLED () { return config.get<boolean>('followers.instance.enabled') },
 249       get MANUAL_APPROVAL () { return config.get<boolean>('followers.instance.manual_approval') }
 250     }
 251   },
 252   FOLLOWINGS: {
 253     INSTANCE: {
 254       AUTO_FOLLOW_BACK: {
 255         get ENABLED () {
 256           return config.get<boolean>('followings.instance.auto_follow_back.enabled')
 257         }
 258       },
 259       AUTO_FOLLOW_INDEX: {
 260         get ENABLED () {
 261           return config.get<boolean>('followings.instance.auto_follow_index.enabled')
 262         },
 263         get INDEX_URL () {
 264           return config.get<string>('followings.instance.auto_follow_index.index_url')
 265         }
 266       }
 267     }
 268   },
 269   THEME: {
 270     get DEFAULT () { return config.get<string>('theme.default') }
 271   }
 272 }
 273
 274 function registerConfigChangedHandler (fun: Function) {
 275   configChangedHandlers.push(fun)
 276 }
 277
 278 // ---------------------------------------------------------------------------
 279
 280 export {
 281   CONFIG,
 282   registerConfigChangedHandler
 283 }
 284
 285 // ---------------------------------------------------------------------------
 286
 287 function getLocalConfigFilePath () {
 288   const configSources = config.util.getConfigSources()
 289   if (configSources.length === 0) throw new Error('Invalid config source.')
 290
 291   let filename = 'local'
 292   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 293   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 294
 295   return join(dirname(configSources[ 0 ].name), filename + '.json')
 296 }
 297
 298 function buildVideosRedundancy (objs: any[]): VideosRedundancy[] {
 299   if (!objs) return []
 300
 301   if (!Array.isArray(objs)) return objs
 302
 303   return objs.map(obj => {
 304     return Object.assign({}, obj, {
 305       minLifetime: parseDurationToMs(obj.min_lifetime),
 306       size: bytes.parse(obj.size),
 307       minViews: obj.min_views
 308     })
 309   })
 310 }
 311
 312 export function reloadConfig () {
 313
 314   function directory () {
 315     if (process.env.NODE_CONFIG_DIR) {
 316       return process.env.NODE_CONFIG_DIR
 317     }
 318
 319     return join(root(), 'config')
 320   }
 321
 322   function purge () {
 323     for (const fileName in require.cache) {
 324       if (-1 === fileName.indexOf(directory())) {
 325         continue
 326       }
 327
 328       delete require.cache[fileName]
 329     }
 330
 331     delete require.cache[require.resolve('config')]
 332   }
 333
 334   purge()
 335
 336   config = require('config')
 337
 338   for (const configChangedHandler of configChangedHandlers) {
 339     configChangedHandler()
 340   }
 341 }