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     LOG_PING_REQUESTS: config.get<boolean>('log.log_ping_requests'),
 109     PRETTIFY_SQL: config.get<boolean>('log.prettify_sql')
 110   },
 111   TRENDING: {
 112     VIDEOS: {
 113       INTERVAL_DAYS: config.get<number>('trending.videos.interval_days'),
 114       ALGORITHMS: {
 115         get ENABLED () { return config.get<string[]>('trending.videos.algorithms.enabled') },
 116         get DEFAULT () { return config.get<string>('trending.videos.algorithms.default') }
 117       }
 118     }
 119   },
 120   REDUNDANCY: {
 121     VIDEOS: {
 122       CHECK_INTERVAL: parseDurationToMs(config.get<string>('redundancy.videos.check_interval')),
 123       STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
 124     }
 125   },
 126   REMOTE_REDUNDANCY: {
 127     VIDEOS: {
 128       ACCEPT_FROM: config.get<VideoRedundancyConfigFilter>('remote_redundancy.videos.accept_from')
 129     }
 130   },
 131   CSP: {
 132     ENABLED: config.get<boolean>('csp.enabled'),
 133     REPORT_ONLY: config.get<boolean>('csp.report_only'),
 134     REPORT_URI: config.get<string>('csp.report_uri')
 135   },
 136   TRACKER: {
 137     ENABLED: config.get<boolean>('tracker.enabled'),
 138     PRIVATE: config.get<boolean>('tracker.private'),
 139     REJECT_TOO_MANY_ANNOUNCES: config.get<boolean>('tracker.reject_too_many_announces')
 140   },
 141   HISTORY: {
 142     VIDEOS: {
 143       MAX_AGE: parseDurationToMs(config.get('history.videos.max_age'))
 144     }
 145   },
 146   VIEWS: {
 147     VIDEOS: {
 148       REMOTE: {
 149         MAX_AGE: parseDurationToMs(config.get('views.videos.remote.max_age'))
 150       }
 151     }
 152   },
 153   PLUGINS: {
 154     INDEX: {
 155       ENABLED: config.get<boolean>('plugins.index.enabled'),
 156       CHECK_LATEST_VERSIONS_INTERVAL: parseDurationToMs(config.get<string>('plugins.index.check_latest_versions_interval')),
 157       URL: config.get<string>('plugins.index.url')
 158     }
 159   },
 160   FEDERATION: {
 161     VIDEOS: {
 162       FEDERATE_UNLISTED: config.get<boolean>('federation.videos.federate_unlisted'),
 163       CLEANUP_REMOTE_INTERACTIONS: config.get<boolean>('federation.videos.cleanup_remote_interactions')
 164     }
 165   },
 166   ADMIN: {
 167     get EMAIL () { return config.get<string>('admin.email') }
 168   },
 169   CONTACT_FORM: {
 170     get ENABLED () { return config.get<boolean>('contact_form.enabled') }
 171   },
 172   SIGNUP: {
 173     get ENABLED () { return config.get<boolean>('signup.enabled') },
 174     get LIMIT () { return config.get<number>('signup.limit') },
 175     get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
 176     FILTERS: {
 177       CIDR: {
 178         get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
 179         get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
 180       }
 181     }
 182   },
 183   USER: {
 184     get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
 185     get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
 186   },
 187   TRANSCODING: {
 188     get ENABLED () { return config.get<boolean>('transcoding.enabled') },
 189     get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
 190     get ALLOW_AUDIO_FILES () { return config.get<boolean>('transcoding.allow_audio_files') },
 191     get THREADS () { return config.get<number>('transcoding.threads') },
 192     get CONCURRENCY () { return config.get<number>('transcoding.concurrency') },
 193     get PROFILE () { return config.get<string>('transcoding.profile') },
 194     RESOLUTIONS: {
 195       get '0p' () { return config.get<boolean>('transcoding.resolutions.0p') },
 196       get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
 197       get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
 198       get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
 199       get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
 200       get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') },
 201       get '1440p' () { return config.get<boolean>('transcoding.resolutions.1440p') },
 202       get '2160p' () { return config.get<boolean>('transcoding.resolutions.2160p') }
 203     },
 204     HLS: {
 205       get ENABLED () { return config.get<boolean>('transcoding.hls.enabled') }
 206     },
 207     WEBTORRENT: {
 208       get ENABLED () { return config.get<boolean>('transcoding.webtorrent.enabled') }
 209     }
 210   },
 211   LIVE: {
 212     get ENABLED () { return config.get<boolean>('live.enabled') },
 213
 214     get MAX_DURATION () { return parseDurationToMs(config.get<string>('live.max_duration')) },
 215     get MAX_INSTANCE_LIVES () { return config.get<number>('live.max_instance_lives') },
 216     get MAX_USER_LIVES () { return config.get<number>('live.max_user_lives') },
 217
 218     get ALLOW_REPLAY () { return config.get<boolean>('live.allow_replay') },
 219
 220     RTMP: {
 221       get PORT () { return config.get<number>('live.rtmp.port') }
 222     },
 223
 224     TRANSCODING: {
 225       get ENABLED () { return config.get<boolean>('live.transcoding.enabled') },
 226       get THREADS () { return config.get<number>('live.transcoding.threads') },
 227       get PROFILE () { return config.get<string>('live.transcoding.profile') },
 228
 229       RESOLUTIONS: {
 230         get '240p' () { return config.get<boolean>('live.transcoding.resolutions.240p') },
 231         get '360p' () { return config.get<boolean>('live.transcoding.resolutions.360p') },
 232         get '480p' () { return config.get<boolean>('live.transcoding.resolutions.480p') },
 233         get '720p' () { return config.get<boolean>('live.transcoding.resolutions.720p') },
 234         get '1080p' () { return config.get<boolean>('live.transcoding.resolutions.1080p') },
 235         get '1440p' () { return config.get<boolean>('live.transcoding.resolutions.1440p') },
 236         get '2160p' () { return config.get<boolean>('live.transcoding.resolutions.2160p') }
 237       }
 238     }
 239   },
 240   IMPORT: {
 241     VIDEOS: {
 242       get CONCURRENCY () { return config.get<number>('import.videos.concurrency') },
 243
 244       HTTP: {
 245         get ENABLED () { return config.get<boolean>('import.videos.http.enabled') },
 246         get FORCE_IPV4 () { return config.get<boolean>('import.videos.http.force_ipv4') },
 247         PROXY: {
 248           get ENABLED () { return config.get<boolean>('import.videos.http.proxy.enabled') },
 249           get URL () { return config.get<string>('import.videos.http.proxy.url') }
 250         }
 251       },
 252       TORRENT: {
 253         get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
 254       }
 255     }
 256   },
 257   AUTO_BLACKLIST: {
 258     VIDEOS: {
 259       OF_USERS: {
 260         get ENABLED () { return config.get<boolean>('auto_blacklist.videos.of_users.enabled') }
 261       }
 262     }
 263   },
 264   CACHE: {
 265     PREVIEWS: {
 266       get SIZE () { return config.get<number>('cache.previews.size') }
 267     },
 268     VIDEO_CAPTIONS: {
 269       get SIZE () { return config.get<number>('cache.captions.size') }
 270     },
 271     TORRENTS: {
 272       get SIZE () { return config.get<number>('cache.torrents.size') }
 273     }
 274   },
 275   INSTANCE: {
 276     get NAME () { return config.get<string>('instance.name') },
 277     get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
 278     get DESCRIPTION () { return config.get<string>('instance.description') },
 279     get TERMS () { return config.get<string>('instance.terms') },
 280     get CODE_OF_CONDUCT () { return config.get<string>('instance.code_of_conduct') },
 281
 282     get CREATION_REASON () { return config.get<string>('instance.creation_reason') },
 283
 284     get MODERATION_INFORMATION () { return config.get<string>('instance.moderation_information') },
 285     get ADMINISTRATOR () { return config.get<string>('instance.administrator') },
 286     get MAINTENANCE_LIFETIME () { return config.get<string>('instance.maintenance_lifetime') },
 287     get BUSINESS_MODEL () { return config.get<string>('instance.business_model') },
 288     get HARDWARE_INFORMATION () { return config.get<string>('instance.hardware_information') },
 289
 290     get LANGUAGES () { return config.get<string[]>('instance.languages') || [] },
 291     get CATEGORIES () { return config.get<number[]>('instance.categories') || [] },
 292
 293     get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
 294     get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
 295
 296     get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
 297
 298     CUSTOMIZATIONS: {
 299       get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
 300       get CSS () { return config.get<string>('instance.customizations.css') }
 301     },
 302     get ROBOTS () { return config.get<string>('instance.robots') },
 303     get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
 304     get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
 305   },
 306   SERVICES: {
 307     TWITTER: {
 308       get USERNAME () { return config.get<string>('services.twitter.username') },
 309       get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
 310     }
 311   },
 312   FOLLOWERS: {
 313     INSTANCE: {
 314       get ENABLED () { return config.get<boolean>('followers.instance.enabled') },
 315       get MANUAL_APPROVAL () { return config.get<boolean>('followers.instance.manual_approval') }
 316     }
 317   },
 318   FOLLOWINGS: {
 319     INSTANCE: {
 320       AUTO_FOLLOW_BACK: {
 321         get ENABLED () {
 322           return config.get<boolean>('followings.instance.auto_follow_back.enabled')
 323         }
 324       },
 325       AUTO_FOLLOW_INDEX: {
 326         get ENABLED () {
 327           return config.get<boolean>('followings.instance.auto_follow_index.enabled')
 328         },
 329         get INDEX_URL () {
 330           return config.get<string>('followings.instance.auto_follow_index.index_url')
 331         }
 332       }
 333     }
 334   },
 335   THEME: {
 336     get DEFAULT () { return config.get<string>('theme.default') }
 337   },
 338   BROADCAST_MESSAGE: {
 339     get ENABLED () { return config.get<boolean>('broadcast_message.enabled') },
 340     get MESSAGE () { return config.get<string>('broadcast_message.message') },
 341     get LEVEL () { return config.get<BroadcastMessageLevel>('broadcast_message.level') },
 342     get DISMISSABLE () { return config.get<boolean>('broadcast_message.dismissable') }
 343   },
 344   SEARCH: {
 345     REMOTE_URI: {
 346       get USERS () { return config.get<boolean>('search.remote_uri.users') },
 347       get ANONYMOUS () { return config.get<boolean>('search.remote_uri.anonymous') }
 348     },
 349     SEARCH_INDEX: {
 350       get ENABLED () { return config.get<boolean>('search.search_index.enabled') },
 351       get URL () { return config.get<string>('search.search_index.url') },
 352       get DISABLE_LOCAL_SEARCH () { return config.get<boolean>('search.search_index.disable_local_search') },
 353       get IS_DEFAULT_SEARCH () { return config.get<boolean>('search.search_index.is_default_search') }
 354     }
 355   }
 356 }
 357
 358 function registerConfigChangedHandler (fun: Function) {
 359   configChangedHandlers.push(fun)
 360 }
 361
 362 function isEmailEnabled () {
 363   if (CONFIG.SMTP.TRANSPORT === 'sendmail' && CONFIG.SMTP.SENDMAIL) return true
 364
 365   if (CONFIG.SMTP.TRANSPORT === 'smtp' && CONFIG.SMTP.HOSTNAME && CONFIG.SMTP.PORT) return true
 366
 367   return false
 368 }
 369
 370 // ---------------------------------------------------------------------------
 371
 372 export {
 373   CONFIG,
 374   registerConfigChangedHandler,
 375   isEmailEnabled
 376 }
 377
 378 // ---------------------------------------------------------------------------
 379
 380 function getLocalConfigFilePath () {
 381   const configSources = config.util.getConfigSources()
 382   if (configSources.length === 0) throw new Error('Invalid config source.')
 383
 384   let filename = 'local'
 385   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 386   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 387
 388   return join(dirname(configSources[0].name), filename + '.json')
 389 }
 390
 391 function buildVideosRedundancy (objs: any[]): VideosRedundancyStrategy[] {
 392   if (!objs) return []
 393
 394   if (!Array.isArray(objs)) return objs
 395
 396   return objs.map(obj => {
 397     return Object.assign({}, obj, {
 398       minLifetime: parseDurationToMs(obj.min_lifetime),
 399       size: bytes.parse(obj.size),
 400       minViews: obj.min_views
 401     })
 402   })
 403 }
 404
 405 export function reloadConfig () {
 406
 407   function directory () {
 408     if (process.env.NODE_CONFIG_DIR) {
 409       return process.env.NODE_CONFIG_DIR
 410     }
 411
 412     return join(root(), 'config')
 413   }
 414
 415   function purge () {
 416     for (const fileName in require.cache) {
 417       if (fileName.includes(directory()) === false) {
 418         continue
 419       }
 420
 421       delete require.cache[fileName]
 422     }
 423
 424     delete require.cache[require.resolve('config')]
 425   }
 426
 427   purge()
 428
 429   config = require('config')
 430
 431   for (const configChangedHandler of configChangedHandlers) {
 432     configChangedHandler()
 433   }
 434 }