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