server/initializers/config.ts

   1 import { IConfig } from 'config'
   2 import { dirname, join } from 'path'
   3 import { VideosRedundancyStrategy } 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 import { VideoRedundancyConfigFilter } from '@shared/models/redundancy/video-redundancy-config-filter.type'
   9 import { BroadcastMessageLevel } from '@shared/models/server'
  10
  11 // Use a variable to reload the configuration if we need
  12 let config: IConfig = require('config')
  13
  14 const configChangedHandlers: Function[] = []
  15
  16 const CONFIG = {
  17   CUSTOM_FILE: getLocalConfigFilePath(),
  18   LISTEN: {
  19     PORT: config.get<number>('listen.port'),
  20     HOSTNAME: config.get<string>('listen.hostname')
  21   },
  22   DATABASE: {
  23     DBNAME: 'peertube' + config.get<string>('database.suffix'),
  24     HOSTNAME: config.get<string>('database.hostname'),
  25     PORT: config.get<number>('database.port'),
  26     USERNAME: config.get<string>('database.username'),
  27     PASSWORD: config.get<string>('database.password'),
  28     POOL: {
  29       MAX: config.get<number>('database.pool.max')
  30     }
  31   },
  32   REDIS: {
  33     HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
  34     PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
  35     SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
  36     AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
  37     DB: config.has('redis.db') ? config.get<number>('redis.db') : null
  38   },
  39   SMTP: {
  40     TRANSPORT: config.has('smtp.transport') ? config.get<string>('smtp.transport') : 'smtp',
  41     SENDMAIL: config.has('smtp.sendmail') ? config.get<string>('smtp.sendmail') : null,
  42     HOSTNAME: config.get<string>('smtp.hostname'),
  43     PORT: config.get<number>('smtp.port'),
  44     USERNAME: config.get<string>('smtp.username'),
  45     PASSWORD: config.get<string>('smtp.password'),
  46     TLS: config.get<boolean>('smtp.tls'),
  47     DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
  48     CA_FILE: config.get<string>('smtp.ca_file'),
  49     FROM_ADDRESS: config.get<string>('smtp.from_address')
  50   },
  51   EMAIL: {
  52     BODY: {
  53       SIGNATURE: config.get<string>('email.body.signature')
  54     },
  55     SUBJECT: {
  56       PREFIX: config.get<string>('email.subject.prefix') + ' '
  57     }
  58   },
  59   STORAGE: {
  60     TMP_DIR: buildPath(config.get<string>('storage.tmp')),
  61     AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
  62     LOG_DIR: buildPath(config.get<string>('storage.logs')),
  63     VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
  64     STREAMING_PLAYLISTS_DIR: buildPath(config.get<string>('storage.streaming_playlists')),
  65     REDUNDANCY_DIR: buildPath(config.get<string>('storage.redundancy')),
  66     THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
  67     PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
  68     CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
  69     TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
  70     CACHE_DIR: buildPath(config.get<string>('storage.cache')),
  71     PLUGINS_DIR: buildPath(config.get<string>('storage.plugins'))
  72   },
  73   WEBSERVER: {
  74     SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
  75     WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
  76     HOSTNAME: config.get<string>('webserver.hostname'),
  77     PORT: config.get<number>('webserver.port')
  78   },
  79   RATES_LIMIT: {
  80     API: {
  81       WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.api.window')),
  82       MAX: config.get<number>('rates_limit.api.max')
  83     },
  84     SIGNUP: {
  85       WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.signup.window')),
  86       MAX: config.get<number>('rates_limit.signup.max')
  87     },
  88     LOGIN: {
  89       WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.login.window')),
  90       MAX: config.get<number>('rates_limit.login.max')
  91     },
  92     ASK_SEND_EMAIL: {
  93       WINDOW_MS: parseDurationToMs(config.get<string>('rates_limit.ask_send_email.window')),
  94       MAX: config.get<number>('rates_limit.ask_send_email.max')
  95     }
  96   },
  97   TRUST_PROXY: config.get<string[]>('trust_proxy'),
  98   LOG: {
  99     LEVEL: config.get<string>('log.level'),
 100     ROTATION: {
 101       ENABLED: config.get<boolean>('log.rotation.enabled'),
 102       MAX_FILE_SIZE: bytes.parse(config.get<string>('log.rotation.maxFileSize')),
 103       MAX_FILES: config.get<number>('log.rotation.maxFiles')
 104     },
 105     ANONYMIZE_IP: config.get<boolean>('log.anonymizeIP')
 106   },
 107   SEARCH: {
 108     REMOTE_URI: {
 109       USERS: config.get<boolean>('search.remote_uri.users'),
 110       ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous')
 111     }
 112   },
 113   TRENDING: {
 114     VIDEOS: {
 115       INTERVAL_DAYS: config.get<number>('trending.videos.interval_days')
 116     }
 117   },
 118   REDUNDANCY: {
 119     VIDEOS: {
 120       CHECK_INTERVAL: parseDurationToMs(config.get<string>('redundancy.videos.check_interval')),
 121       STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
 122     }
 123   },
 124   REMOTE_REDUNDANCY: {
 125     VIDEOS: {
 126       ACCEPT_FROM: config.get<VideoRedundancyConfigFilter>('remote_redundancy.videos.accept_from')
 127     }
 128   },
 129   CSP: {
 130     ENABLED: config.get<boolean>('csp.enabled'),
 131     REPORT_ONLY: config.get<boolean>('csp.report_only'),
 132     REPORT_URI: config.get<boolean>('csp.report_uri')
 133   },
 134   TRACKER: {
 135     ENABLED: config.get<boolean>('tracker.enabled'),
 136     PRIVATE: config.get<boolean>('tracker.private'),
 137     REJECT_TOO_MANY_ANNOUNCES: config.get<boolean>('tracker.reject_too_many_announces')
 138   },
 139   HISTORY: {
 140     VIDEOS: {
 141       MAX_AGE: parseDurationToMs(config.get('history.videos.max_age'))
 142     }
 143   },
 144   VIEWS: {
 145     VIDEOS: {
 146       REMOTE: {
 147         MAX_AGE: parseDurationToMs(config.get('views.videos.remote.max_age'))
 148       }
 149     }
 150   },
 151   PLUGINS: {
 152     INDEX: {
 153       ENABLED: config.get<boolean>('plugins.index.enabled'),
 154       CHECK_LATEST_VERSIONS_INTERVAL: parseDurationToMs(config.get<string>('plugins.index.check_latest_versions_interval')),
 155       URL: config.get<string>('plugins.index.url')
 156     }
 157   },
 158   ADMIN: {
 159     get EMAIL () { return config.get<string>('admin.email') }
 160   },
 161   CONTACT_FORM: {
 162     get ENABLED () { return config.get<boolean>('contact_form.enabled') }
 163   },
 164   SIGNUP: {
 165     get ENABLED () { return config.get<boolean>('signup.enabled') },
 166     get LIMIT () { return config.get<number>('signup.limit') },
 167     get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
 168     FILTERS: {
 169       CIDR: {
 170         get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
 171         get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
 172       }
 173     }
 174   },
 175   USER: {
 176     get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
 177     get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
 178   },
 179   TRANSCODING: {
 180     get ENABLED () { return config.get<boolean>('transcoding.enabled') },
 181     get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
 182     get ALLOW_AUDIO_FILES () { return config.get<boolean>('transcoding.allow_audio_files') },
 183     get THREADS () { return config.get<number>('transcoding.threads') },
 184     RESOLUTIONS: {
 185       get '0p' () { return config.get<boolean>('transcoding.resolutions.0p') },
 186       get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
 187       get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
 188       get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
 189       get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
 190       get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') },
 191       get '2160p' () { return config.get<boolean>('transcoding.resolutions.2160p') }
 192     },
 193     HLS: {
 194       get ENABLED () { return config.get<boolean>('transcoding.hls.enabled') }
 195     },
 196     WEBTORRENT: {
 197       get ENABLED () { return config.get<boolean>('transcoding.webtorrent.enabled') }
 198     }
 199   },
 200   IMPORT: {
 201     VIDEOS: {
 202       HTTP: {
 203         get ENABLED () { return config.get<boolean>('import.videos.http.enabled') },
 204         PROXY: {
 205           get ENABLED () { return config.get<boolean>('import.videos.http.proxy.enabled') },
 206           get URL () { return config.get<string>('import.videos.http.proxy.url') }
 207         }
 208       },
 209       TORRENT: {
 210         get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
 211       }
 212     }
 213   },
 214   AUTO_BLACKLIST: {
 215     VIDEOS: {
 216       OF_USERS: {
 217         get ENABLED () { return config.get<boolean>('auto_blacklist.videos.of_users.enabled') }
 218       }
 219     }
 220   },
 221   CACHE: {
 222     PREVIEWS: {
 223       get SIZE () { return config.get<number>('cache.previews.size') }
 224     },
 225     VIDEO_CAPTIONS: {
 226       get SIZE () { return config.get<number>('cache.captions.size') }
 227     }
 228   },
 229   INSTANCE: {
 230     get NAME () { return config.get<string>('instance.name') },
 231     get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
 232     get DESCRIPTION () { return config.get<string>('instance.description') },
 233     get TERMS () { return config.get<string>('instance.terms') },
 234     get CODE_OF_CONDUCT () { return config.get<string>('instance.code_of_conduct') },
 235
 236     get CREATION_REASON () { return config.get<string>('instance.creation_reason') },
 237
 238     get MODERATION_INFORMATION () { return config.get<string>('instance.moderation_information') },
 239     get ADMINISTRATOR () { return config.get<string>('instance.administrator') },
 240     get MAINTENANCE_LIFETIME () { return config.get<string>('instance.maintenance_lifetime') },
 241     get BUSINESS_MODEL () { return config.get<string>('instance.business_model') },
 242     get HARDWARE_INFORMATION () { return config.get<string>('instance.hardware_information') },
 243
 244     get LANGUAGES () { return config.get<string[]>('instance.languages') || [] },
 245     get CATEGORIES () { return config.get<number[]>('instance.categories') || [] },
 246
 247     get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
 248     get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
 249     get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
 250     CUSTOMIZATIONS: {
 251       get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
 252       get CSS () { return config.get<string>('instance.customizations.css') }
 253     },
 254     get ROBOTS () { return config.get<string>('instance.robots') },
 255     get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
 256     get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
 257   },
 258   SERVICES: {
 259     TWITTER: {
 260       get USERNAME () { return config.get<string>('services.twitter.username') },
 261       get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
 262     }
 263   },
 264   FOLLOWERS: {
 265     INSTANCE: {
 266       get ENABLED () { return config.get<boolean>('followers.instance.enabled') },
 267       get MANUAL_APPROVAL () { return config.get<boolean>('followers.instance.manual_approval') }
 268     }
 269   },
 270   FOLLOWINGS: {
 271     INSTANCE: {
 272       AUTO_FOLLOW_BACK: {
 273         get ENABLED () {
 274           return config.get<boolean>('followings.instance.auto_follow_back.enabled')
 275         }
 276       },
 277       AUTO_FOLLOW_INDEX: {
 278         get ENABLED () {
 279           return config.get<boolean>('followings.instance.auto_follow_index.enabled')
 280         },
 281         get INDEX_URL () {
 282           return config.get<string>('followings.instance.auto_follow_index.index_url')
 283         }
 284       }
 285     }
 286   },
 287   THEME: {
 288     get DEFAULT () { return config.get<string>('theme.default') }
 289   },
 290   BROADCAST_MESSAGE: {
 291     get ENABLED () { return config.get<boolean>('broadcast_message.enabled') },
 292     get MESSAGE () { return config.get<string>('broadcast_message.message') },
 293     get LEVEL () { return config.get<BroadcastMessageLevel>('broadcast_message.level') },
 294     get DISMISSABLE () { return config.get<boolean>('broadcast_message.dismissable') }
 295   }
 296 }
 297
 298 function registerConfigChangedHandler (fun: Function) {
 299   configChangedHandlers.push(fun)
 300 }
 301
 302 function isEmailEnabled () {
 303   return !!CONFIG.SMTP.HOSTNAME && !!CONFIG.SMTP.PORT
 304 }
 305
 306 // ---------------------------------------------------------------------------
 307
 308 export {
 309   CONFIG,
 310   registerConfigChangedHandler,
 311   isEmailEnabled
 312 }
 313
 314 // ---------------------------------------------------------------------------
 315
 316 function getLocalConfigFilePath () {
 317   const configSources = config.util.getConfigSources()
 318   if (configSources.length === 0) throw new Error('Invalid config source.')
 319
 320   let filename = 'local'
 321   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 322   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 323
 324   return join(dirname(configSources[0].name), filename + '.json')
 325 }
 326
 327 function buildVideosRedundancy (objs: any[]): VideosRedundancyStrategy[] {
 328   if (!objs) return []
 329
 330   if (!Array.isArray(objs)) return objs
 331
 332   return objs.map(obj => {
 333     return Object.assign({}, obj, {
 334       minLifetime: parseDurationToMs(obj.min_lifetime),
 335       size: bytes.parse(obj.size),
 336       minViews: obj.min_views
 337     })
 338   })
 339 }
 340
 341 export function reloadConfig () {
 342
 343   function directory () {
 344     if (process.env.NODE_CONFIG_DIR) {
 345       return process.env.NODE_CONFIG_DIR
 346     }
 347
 348     return join(root(), 'config')
 349   }
 350
 351   function purge () {
 352     for (const fileName in require.cache) {
 353       if (fileName.includes(directory()) === false) {
 354         continue
 355       }
 356
 357       delete require.cache[fileName]
 358     }
 359
 360     delete require.cache[require.resolve('config')]
 361   }
 362
 363   purge()
 364
 365   config = require('config')
 366
 367   for (const configChangedHandler of configChangedHandlers) {
 368     configChangedHandler()
 369   }
 370 }