server/initializers/checker.ts

   1 import * as config from 'config'
   2 import { promisify0 } from '../helpers/core-utils'
   3 import { UserModel } from '../models/account/user'
   4 import { ApplicationModel } from '../models/application/application'
   5 import { OAuthClientModel } from '../models/oauth/oauth-client'
   6 import { parse } from 'url'
   7 import { CONFIG } from './constants'
   8 import { logger } from '../helpers/logger'
   9 import { getServerActor } from '../helpers/utils'
  10
  11 async function checkActivityPubUrls () {
  12   const actor = await getServerActor()
  13
  14   const parsed = parse(actor.url)
  15   if (CONFIG.WEBSERVER.HOST !== parsed.host) {
  16     const NODE_ENV = config.util.getEnv('NODE_ENV')
  17     const NODE_CONFIG_DIR = config.util.getEnv('NODE_CONFIG_DIR')
  18
  19     logger.warn(
  20       'It seems PeerTube was started (and created some data) with another domain name. ' +
  21       'This means you will not be able to federate! ' +
  22       'Please use %s %s npm run update-host to fix this.',
  23       NODE_CONFIG_DIR ? `NODE_CONFIG_DIR=${NODE_CONFIG_DIR}` : '',
  24       NODE_ENV ? `NODE_ENV=${NODE_ENV}` : ''
  25     )
  26   }
  27 }
  28
  29 // Some checks on configuration files
  30 // Return an error message, or null if everything is okay
  31 function checkConfig () {
  32   const defaultNSFWPolicy = config.get<string>('instance.default_nsfw_policy')
  33
  34   if ([ 'do_not_list', 'blur', 'display' ].indexOf(defaultNSFWPolicy) === -1) {
  35     return 'NSFW policy setting should be "do_not_list" or "blur" or "display" instead of ' + defaultNSFWPolicy
  36   }
  37
  38   return null
  39 }
  40
  41 // Check the config files
  42 function checkMissedConfig () {
  43   const required = [ 'listen.port', 'listen.hostname',
  44     'webserver.https', 'webserver.hostname', 'webserver.port',
  45     'trust_proxy',
  46     'database.hostname', 'database.port', 'database.suffix', 'database.username', 'database.password', 'database.pool.max',
  47     'smtp.hostname', 'smtp.port', 'smtp.username', 'smtp.password', 'smtp.tls', 'smtp.from_address',
  48     'storage.avatars', 'storage.videos', 'storage.logs', 'storage.previews', 'storage.thumbnails', 'storage.torrents', 'storage.cache',
  49     'log.level',
  50     'user.video_quota', 'user.video_quota_daily',
  51     'cache.previews.size', 'admin.email',
  52     'signup.enabled', 'signup.limit', 'signup.requires_email_verification',
  53     'signup.filters.cidr.whitelist', 'signup.filters.cidr.blacklist',
  54     'transcoding.enabled', 'transcoding.threads',
  55     'import.videos.http.enabled',
  56     'instance.name', 'instance.short_description', 'instance.description', 'instance.terms', 'instance.default_client_route',
  57     'instance.default_nsfw_policy', 'instance.robots',
  58     'services.twitter.username', 'services.twitter.whitelisted'
  59   ]
  60   const requiredAlternatives = [
  61     [ // set
  62       ['redis.hostname', 'redis.port'], // alternative
  63       ['redis.socket']
  64     ]
  65   ]
  66   const miss: string[] = []
  67
  68   for (const key of required) {
  69     if (!config.has(key)) {
  70       miss.push(key)
  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   const Ffmpeg = require('fluent-ffmpeg')
  88   const getAvailableCodecsPromise = promisify0(Ffmpeg.getAvailableCodecs)
  89   const codecs = await getAvailableCodecsPromise()
  90   const canEncode = [ 'libx264' ]
  91
  92   if (CONFIG.TRANSCODING.ENABLED === false) return undefined
  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   checkFFmpegEncoders()
 105 }
 106
 107 // Optional encoders, if present, can be used to improve transcoding
 108 // Here we ask ffmpeg if it detects their presence on the system, so that we can later use them
 109 let supportedOptionalEncoders: Map<string, boolean>
 110 async function checkFFmpegEncoders (): Promise<Map<string, boolean>> {
 111   if (supportedOptionalEncoders !== undefined) {
 112     return supportedOptionalEncoders
 113   }
 114
 115   const Ffmpeg = require('fluent-ffmpeg')
 116   const getAvailableEncodersPromise = promisify0(Ffmpeg.getAvailableEncoders)
 117   const encoders = await getAvailableEncodersPromise()
 118   const optionalEncoders = [ 'libfdk_aac' ]
 119   supportedOptionalEncoders = new Map<string, boolean>()
 120
 121   for (const encoder of optionalEncoders) {
 122     supportedOptionalEncoders.set(encoder,
 123       encoders[encoder] !== undefined
 124     )
 125   }
 126 }
 127
 128 // We get db by param to not import it in this file (import orders)
 129 async function clientsExist () {
 130   const totalClients = await OAuthClientModel.countTotal()
 131
 132   return totalClients !== 0
 133 }
 134
 135 // We get db by param to not import it in this file (import orders)
 136 async function usersExist () {
 137   const totalUsers = await UserModel.countTotal()
 138
 139   return totalUsers !== 0
 140 }
 141
 142 // We get db by param to not import it in this file (import orders)
 143 async function applicationExist () {
 144   const totalApplication = await ApplicationModel.countTotal()
 145
 146   return totalApplication !== 0
 147 }
 148
 149 // ---------------------------------------------------------------------------
 150
 151 export {
 152   checkConfig,
 153   checkFFmpeg,
 154   checkFFmpegEncoders,
 155   checkMissedConfig,
 156   clientsExist,
 157   usersExist,
 158   applicationExist,
 159   checkActivityPubUrls
 160 }