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   FEDERATION: {
 159     VIDEOS: {
 160       FEDERATE_UNLISTED: config.get<boolean>('federation.videos.federate_unlisted')
 161     }
 162   },
 163   ADMIN: {
 164     get EMAIL () { return config.get<string>('admin.email') }
 165   },
 166   CONTACT_FORM: {
 167     get ENABLED () { return config.get<boolean>('contact_form.enabled') }
 168   },
 169   SIGNUP: {
 170     get ENABLED () { return config.get<boolean>('signup.enabled') },
 171     get LIMIT () { return config.get<number>('signup.limit') },
 172     get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
 173     FILTERS: {
 174       CIDR: {
 175         get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
 176         get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
 177       }
 178     }
 179   },
 180   USER: {
 181     get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
 182     get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
 183   },
 184   TRANSCODING: {
 185     get ENABLED () { return config.get<boolean>('transcoding.enabled') },
 186     get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
 187     get ALLOW_AUDIO_FILES () { return config.get<boolean>('transcoding.allow_audio_files') },
 188     get THREADS () { return config.get<number>('transcoding.threads') },
 189     RESOLUTIONS: {
 190       get '0p' () { return config.get<boolean>('transcoding.resolutions.0p') },
 191       get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
 192       get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
 193       get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
 194       get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
 195       get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') },
 196       get '2160p' () { return config.get<boolean>('transcoding.resolutions.2160p') }
 197     },
 198     HLS: {
 199       get ENABLED () { return config.get<boolean>('transcoding.hls.enabled') }
 200     },
 201     WEBTORRENT: {
 202       get ENABLED () { return config.get<boolean>('transcoding.webtorrent.enabled') }
 203     }
 204   },
 205   IMPORT: {
 206     VIDEOS: {
 207       HTTP: {
 208         get ENABLED () { return config.get<boolean>('import.videos.http.enabled') },
 209         PROXY: {
 210           get ENABLED () { return config.get<boolean>('import.videos.http.proxy.enabled') },
 211           get URL () { return config.get<string>('import.videos.http.proxy.url') }
 212         }
 213       },
 214       TORRENT: {
 215         get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
 216       }
 217     }
 218   },
 219   AUTO_BLACKLIST: {
 220     VIDEOS: {
 221       OF_USERS: {
 222         get ENABLED () { return config.get<boolean>('auto_blacklist.videos.of_users.enabled') }
 223       }
 224     }
 225   },
 226   CACHE: {
 227     PREVIEWS: {
 228       get SIZE () { return config.get<number>('cache.previews.size') }
 229     },
 230     VIDEO_CAPTIONS: {
 231       get SIZE () { return config.get<number>('cache.captions.size') }
 232     }
 233   },
 234   INSTANCE: {
 235     get NAME () { return config.get<string>('instance.name') },
 236     get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
 237     get DESCRIPTION () { return config.get<string>('instance.description') },
 238     get TERMS () { return config.get<string>('instance.terms') },
 239     get CODE_OF_CONDUCT () { return config.get<string>('instance.code_of_conduct') },
 240
 241     get CREATION_REASON () { return config.get<string>('instance.creation_reason') },
 242
 243     get MODERATION_INFORMATION () { return config.get<string>('instance.moderation_information') },
 244     get ADMINISTRATOR () { return config.get<string>('instance.administrator') },
 245     get MAINTENANCE_LIFETIME () { return config.get<string>('instance.maintenance_lifetime') },
 246     get BUSINESS_MODEL () { return config.get<string>('instance.business_model') },
 247     get HARDWARE_INFORMATION () { return config.get<string>('instance.hardware_information') },
 248
 249     get LANGUAGES () { return config.get<string[]>('instance.languages') || [] },
 250     get CATEGORIES () { return config.get<number[]>('instance.categories') || [] },
 251
 252     get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
 253     get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
 254     get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
 255     CUSTOMIZATIONS: {
 256       get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
 257       get CSS () { return config.get<string>('instance.customizations.css') }
 258     },
 259     get ROBOTS () { return config.get<string>('instance.robots') },
 260     get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
 261     get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
 262   },
 263   SERVICES: {
 264     TWITTER: {
 265       get USERNAME () { return config.get<string>('services.twitter.username') },
 266       get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
 267     }
 268   },
 269   FOLLOWERS: {
 270     INSTANCE: {
 271       get ENABLED () { return config.get<boolean>('followers.instance.enabled') },
 272       get MANUAL_APPROVAL () { return config.get<boolean>('followers.instance.manual_approval') }
 273     }
 274   },
 275   FOLLOWINGS: {
 276     INSTANCE: {
 277       AUTO_FOLLOW_BACK: {
 278         get ENABLED () {
 279           return config.get<boolean>('followings.instance.auto_follow_back.enabled')
 280         }
 281       },
 282       AUTO_FOLLOW_INDEX: {
 283         get ENABLED () {
 284           return config.get<boolean>('followings.instance.auto_follow_index.enabled')
 285         },
 286         get INDEX_URL () {
 287           return config.get<string>('followings.instance.auto_follow_index.index_url')
 288         }
 289       }
 290     }
 291   },
 292   THEME: {
 293     get DEFAULT () { return config.get<string>('theme.default') }
 294   },
 295   BROADCAST_MESSAGE: {
 296     get ENABLED () { return config.get<boolean>('broadcast_message.enabled') },
 297     get MESSAGE () { return config.get<string>('broadcast_message.message') },
 298     get LEVEL () { return config.get<BroadcastMessageLevel>('broadcast_message.level') },
 299     get DISMISSABLE () { return config.get<boolean>('broadcast_message.dismissable') }
 300   }
 301 }
 302
 303 function registerConfigChangedHandler (fun: Function) {
 304   configChangedHandlers.push(fun)
 305 }
 306
 307 function isEmailEnabled () {
 308   return !!CONFIG.SMTP.HOSTNAME && !!CONFIG.SMTP.PORT
 309 }
 310
 311 // ---------------------------------------------------------------------------
 312
 313 export {
 314   CONFIG,
 315   registerConfigChangedHandler,
 316   isEmailEnabled
 317 }
 318
 319 // ---------------------------------------------------------------------------
 320
 321 function getLocalConfigFilePath () {
 322   const configSources = config.util.getConfigSources()
 323   if (configSources.length === 0) throw new Error('Invalid config source.')
 324
 325   let filename = 'local'
 326   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 327   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 328
 329   return join(dirname(configSources[0].name), filename + '.json')
 330 }
 331
 332 function buildVideosRedundancy (objs: any[]): VideosRedundancyStrategy[] {
 333   if (!objs) return []
 334
 335   if (!Array.isArray(objs)) return objs
 336
 337   return objs.map(obj => {
 338     return Object.assign({}, obj, {
 339       minLifetime: parseDurationToMs(obj.min_lifetime),
 340       size: bytes.parse(obj.size),
 341       minViews: obj.min_views
 342     })
 343   })
 344 }
 345
 346 export function reloadConfig () {
 347
 348   function directory () {
 349     if (process.env.NODE_CONFIG_DIR) {
 350       return process.env.NODE_CONFIG_DIR
 351     }
 352
 353     return join(root(), 'config')
 354   }
 355
 356   function purge () {
 357     for (const fileName in require.cache) {
 358       if (fileName.includes(directory()) === false) {
 359         continue
 360       }
 361
 362       delete require.cache[fileName]
 363     }
 364
 365     delete require.cache[require.resolve('config')]
 366   }
 367
 368   purge()
 369
 370   config = require('config')
 371
 372   for (const configChangedHandler of configChangedHandlers) {
 373     configChangedHandler()
 374   }
 375 }