server/initializers/checker-before-init.ts

   1 import * as config from 'config'
   2 import { promisify0 } from '../helpers/core-utils'
   3
   4 // ONLY USE CORE MODULES IN THIS FILE!
   5
   6 // Check the config files
   7 function checkMissedConfig () {
   8   const required = [ 'listen.port', 'listen.hostname',
   9     'webserver.https', 'webserver.hostname', 'webserver.port',
  10     'trust_proxy',
  11     'database.hostname', 'database.port', 'database.suffix', 'database.username', 'database.password', 'database.pool.max',
  12     'smtp.hostname', 'smtp.port', 'smtp.username', 'smtp.password', 'smtp.tls', 'smtp.from_address',
  13     'email.body.signature', 'email.object.prefix',
  14     'storage.avatars', 'storage.videos', 'storage.logs', 'storage.previews', 'storage.thumbnails', 'storage.torrents', 'storage.cache',
  15     'storage.redundancy', 'storage.tmp', 'storage.streaming_playlists', 'storage.plugins',
  16     'log.level',
  17     'user.video_quota', 'user.video_quota_daily',
  18     'csp.enabled', 'csp.report_only', 'csp.report_uri',
  19     'cache.previews.size', 'admin.email', 'contact_form.enabled',
  20     'signup.enabled', 'signup.limit', 'signup.requires_email_verification',
  21     'signup.filters.cidr.whitelist', 'signup.filters.cidr.blacklist',
  22     'redundancy.videos.strategies', 'redundancy.videos.check_interval',
  23     'transcoding.enabled', 'transcoding.threads', 'transcoding.allow_additional_extensions',
  24     'import.videos.http.enabled', 'import.videos.torrent.enabled', 'auto_blacklist.videos.of_users.enabled',
  25     'trending.videos.interval_days',
  26     'instance.name', 'instance.short_description', 'instance.description', 'instance.terms', 'instance.default_client_route',
  27     'instance.is_nsfw', 'instance.default_nsfw_policy', 'instance.robots', 'instance.securitytxt',
  28     'services.twitter.username', 'services.twitter.whitelisted',
  29     'followers.instance.enabled', 'followers.instance.manual_approval',
  30     'tracker.enabled', 'tracker.private', 'tracker.reject_too_many_announces',
  31     'history.videos.max_age', 'views.videos.remote.max_age',
  32     'rates_limit.login.window', 'rates_limit.login.max', 'rates_limit.ask_send_email.window', 'rates_limit.ask_send_email.max'
  33   ]
  34   const requiredAlternatives = [
  35     [ // set
  36       ['redis.hostname', 'redis.port'], // alternative
  37       ['redis.socket']
  38     ]
  39   ]
  40   const miss: string[] = []
  41
  42   for (const key of required) {
  43     if (!config.has(key)) {
  44       miss.push(key)
  45     }
  46   }
  47
  48   const redundancyVideos = config.get<any>('redundancy.videos.strategies')
  49
  50   if (Array.isArray(redundancyVideos)) {
  51     for (const r of redundancyVideos) {
  52       if (!r.size) miss.push('redundancy.videos.strategies.size')
  53       if (!r.min_lifetime) miss.push('redundancy.videos.strategies.min_lifetime')
  54     }
  55   }
  56
  57   const missingAlternatives = requiredAlternatives.filter(
  58     set => !set.find(alternative => !alternative.find(key => !config.has(key)))
  59   )
  60
  61   missingAlternatives
  62     .forEach(set => set[0].forEach(key => miss.push(key)))
  63
  64   return miss
  65 }
  66
  67 // Check the available codecs
  68 // We get CONFIG by param to not import it in this file (import orders)
  69 async function checkFFmpeg (CONFIG: { TRANSCODING: { ENABLED: boolean } }) {
  70   const Ffmpeg = require('fluent-ffmpeg')
  71   const getAvailableCodecsPromise = promisify0(Ffmpeg.getAvailableCodecs)
  72   const codecs = await getAvailableCodecsPromise()
  73   const canEncode = [ 'libx264' ]
  74
  75   if (CONFIG.TRANSCODING.ENABLED === false) return undefined
  76
  77   for (const codec of canEncode) {
  78     if (codecs[codec] === undefined) {
  79       throw new Error('Unknown codec ' + codec + ' in FFmpeg.')
  80     }
  81
  82     if (codecs[codec].canEncode !== true) {
  83       throw new Error('Unavailable encode codec ' + codec + ' in FFmpeg')
  84     }
  85   }
  86
  87   return checkFFmpegEncoders()
  88 }
  89
  90 // Optional encoders, if present, can be used to improve transcoding
  91 // Here we ask ffmpeg if it detects their presence on the system, so that we can later use them
  92 let supportedOptionalEncoders: Map<string, boolean>
  93 async function checkFFmpegEncoders (): Promise<Map<string, boolean>> {
  94   if (supportedOptionalEncoders !== undefined) {
  95     return supportedOptionalEncoders
  96   }
  97
  98   const Ffmpeg = require('fluent-ffmpeg')
  99   const getAvailableEncodersPromise = promisify0(Ffmpeg.getAvailableEncoders)
 100   const encoders = await getAvailableEncodersPromise()
 101   const optionalEncoders = [ 'libfdk_aac' ]
 102   supportedOptionalEncoders = new Map<string, boolean>()
 103
 104   for (const encoder of optionalEncoders) {
 105     supportedOptionalEncoders.set(encoder, encoders[encoder] !== undefined)
 106   }
 107
 108   return supportedOptionalEncoders
 109 }
 110
 111 // ---------------------------------------------------------------------------
 112
 113 export {
 114   checkFFmpeg,
 115   checkFFmpegEncoders,
 116   checkMissedConfig
 117 }