server/initializers/checker-before-init.ts

   1 import * as config from 'config'
   2 import { parseSemVersion, promisify0 } from '../helpers/core-utils'
   3 import { logger } from '../helpers/logger'
   4
   5 // ONLY USE CORE MODULES IN THIS FILE!
   6
   7 // Check the config files
   8 function checkMissedConfig () {
   9   const required = [ 'listen.port', 'listen.hostname',
  10     'webserver.https', 'webserver.hostname', 'webserver.port',
  11     'trust_proxy',
  12     'database.hostname', 'database.port', 'database.username', 'database.password', 'database.pool.max',
  13     'smtp.hostname', 'smtp.port', 'smtp.username', 'smtp.password', 'smtp.tls', 'smtp.from_address',
  14     'email.body.signature', 'email.subject.prefix',
  15     'storage.avatars', 'storage.videos', 'storage.logs', 'storage.previews', 'storage.thumbnails', 'storage.torrents', 'storage.cache',
  16     'storage.redundancy', 'storage.tmp', 'storage.streaming_playlists', 'storage.plugins',
  17     'log.level',
  18     'user.video_quota', 'user.video_quota_daily',
  19     'csp.enabled', 'csp.report_only', 'csp.report_uri',
  20     'cache.previews.size', 'cache.captions.size', 'cache.torrents.size', 'admin.email', 'contact_form.enabled',
  21     'signup.enabled', 'signup.limit', 'signup.requires_email_verification',
  22     'signup.filters.cidr.whitelist', 'signup.filters.cidr.blacklist',
  23     'redundancy.videos.strategies', 'redundancy.videos.check_interval',
  24     'transcoding.enabled', 'transcoding.threads', 'transcoding.allow_additional_extensions', 'transcoding.hls.enabled',
  25     'transcoding.profile', 'transcoding.concurrency',
  26     'transcoding.resolutions.0p', 'transcoding.resolutions.240p', 'transcoding.resolutions.360p', 'transcoding.resolutions.480p',
  27     'transcoding.resolutions.720p', 'transcoding.resolutions.1080p', 'transcoding.resolutions.1440p', 'transcoding.resolutions.2160p',
  28     'import.videos.http.enabled', 'import.videos.torrent.enabled', 'import.videos.concurrency', 'auto_blacklist.videos.of_users.enabled',
  29     'trending.videos.interval_days',
  30     'instance.name', 'instance.short_description', 'instance.description', 'instance.terms', 'instance.default_client_route',
  31     'instance.is_nsfw', 'instance.default_nsfw_policy', 'instance.robots', 'instance.securitytxt',
  32     'services.twitter.username', 'services.twitter.whitelisted',
  33     'followers.instance.enabled', 'followers.instance.manual_approval',
  34     'tracker.enabled', 'tracker.private', 'tracker.reject_too_many_announces',
  35     'history.videos.max_age', 'views.videos.remote.max_age',
  36     'rates_limit.login.window', 'rates_limit.login.max', 'rates_limit.ask_send_email.window', 'rates_limit.ask_send_email.max',
  37     'theme.default',
  38     'remote_redundancy.videos.accept_from',
  39     'federation.videos.federate_unlisted', 'federation.videos.cleanup_remote_interactions',
  40     'peertube.check_latest_version.enabled', 'peertube.check_latest_version.url',
  41     'search.remote_uri.users', 'search.remote_uri.anonymous', 'search.search_index.enabled', 'search.search_index.url',
  42     'search.search_index.disable_local_search', 'search.search_index.is_default_search',
  43     'live.enabled', 'live.allow_replay', 'live.max_duration', 'live.max_user_lives', 'live.max_instance_lives',
  44     'live.transcoding.enabled', 'live.transcoding.threads', 'live.transcoding.profile',
  45     'live.transcoding.resolutions.240p', 'live.transcoding.resolutions.360p', 'live.transcoding.resolutions.480p',
  46     'live.transcoding.resolutions.720p', 'live.transcoding.resolutions.1080p', 'live.transcoding.resolutions.1440p',
  47     'live.transcoding.resolutions.2160p'
  48   ]
  49
  50   const requiredAlternatives = [
  51     [ // set
  52       [ 'redis.hostname', 'redis.port' ], // alternative
  53       [ 'redis.socket' ]
  54     ]
  55   ]
  56   const miss: string[] = []
  57
  58   for (const key of required) {
  59     if (!config.has(key)) {
  60       miss.push(key)
  61     }
  62   }
  63
  64   const redundancyVideos = config.get<any>('redundancy.videos.strategies')
  65
  66   if (Array.isArray(redundancyVideos)) {
  67     for (const r of redundancyVideos) {
  68       if (!r.size) miss.push('redundancy.videos.strategies.size')
  69       if (!r.min_lifetime) miss.push('redundancy.videos.strategies.min_lifetime')
  70     }
  71   }
  72
  73   const missingAlternatives = requiredAlternatives.filter(
  74     set => !set.find(alternative => !alternative.find(key => !config.has(key)))
  75   )
  76
  77   missingAlternatives
  78     .forEach(set => set[0].forEach(key => miss.push(key)))
  79
  80   return miss
  81 }
  82
  83 // Check the available codecs
  84 // We get CONFIG by param to not import it in this file (import orders)
  85 async function checkFFmpeg (CONFIG: { TRANSCODING: { ENABLED: boolean } }) {
  86   if (CONFIG.TRANSCODING.ENABLED === false) return undefined
  87
  88   const Ffmpeg = require('fluent-ffmpeg')
  89   const getAvailableCodecsPromise = promisify0(Ffmpeg.getAvailableCodecs)
  90   const codecs = await getAvailableCodecsPromise()
  91   const canEncode = [ 'libx264' ]
  92
  93   for (const codec of canEncode) {
  94     if (codecs[codec] === undefined) {
  95       throw new Error('Unknown codec ' + codec + ' in FFmpeg.')
  96     }
  97
  98     if (codecs[codec].canEncode !== true) {
  99       throw new Error('Unavailable encode codec ' + codec + ' in FFmpeg')
 100     }
 101   }
 102 }
 103
 104 function checkNodeVersion () {
 105   const v = process.version
 106   const { major } = parseSemVersion(v)
 107
 108   logger.debug('Checking NodeJS version %s.', v)
 109
 110   if (major <= 10) {
 111     logger.warn('Your NodeJS version %s is deprecated. Please upgrade.', v)
 112   }
 113 }
 114
 115 // ---------------------------------------------------------------------------
 116
 117 export {
 118   checkFFmpeg,
 119   checkMissedConfig,
 120   checkNodeVersion
 121 }