server/initializers/config.ts

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