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