PeerTube/server/initializers/checker-before-init.ts

112 lines
4.0 KiB
TypeScript
Raw Normal View History

2017-06-05 21:53:49 +02:00
import * as config from 'config'
import { promisify0 } from '../helpers/core-utils'
2018-09-11 16:27:07 +02:00
import { isArray } from '../helpers/custom-validators/misc'
// ONLY USE CORE MODULES IN THIS FILE!
// Check the config files
function checkMissedConfig () {
const required = [ 'listen.port', 'listen.hostname',
'webserver.https', 'webserver.hostname', 'webserver.port',
2018-03-29 10:58:24 +02:00
'trust_proxy',
2018-07-28 21:02:26 +02:00
'database.hostname', 'database.port', 'database.suffix', 'database.username', 'database.password', 'database.pool.max',
'smtp.hostname', 'smtp.port', 'smtp.username', 'smtp.password', 'smtp.tls', 'smtp.from_address',
'storage.avatars', 'storage.videos', 'storage.logs', 'storage.previews', 'storage.thumbnails', 'storage.torrents', 'storage.cache',
2018-12-04 16:02:49 +01:00
'storage.redundancy', 'storage.tmp',
'log.level',
'user.video_quota', 'user.video_quota_daily',
2019-01-10 11:12:41 +01:00
'cache.previews.size', 'admin.email', 'contact_form.enabled',
'signup.enabled', 'signup.limit', 'signup.requires_email_verification',
'signup.filters.cidr.whitelist', 'signup.filters.cidr.blacklist',
'redundancy.videos.strategies', 'redundancy.videos.check_interval',
2018-12-11 14:52:50 +01:00
'transcoding.enabled', 'transcoding.threads', 'transcoding.allow_additional_extensions',
2018-08-31 17:18:13 +02:00
'import.videos.http.enabled', 'import.videos.torrent.enabled',
'trending.videos.interval_days',
'instance.name', 'instance.short_description', 'instance.description', 'instance.terms', 'instance.default_client_route',
'instance.default_nsfw_policy', 'instance.robots', 'instance.securitytxt',
'services.twitter.username', 'services.twitter.whitelisted'
2016-10-13 21:48:55 +02:00
]
2018-05-14 17:51:15 +02:00
const requiredAlternatives = [
[ // set
['redis.hostname', 'redis.port'], // alternative
['redis.socket']
]
]
2017-06-10 22:15:25 +02:00
const miss: string[] = []
2016-03-16 22:29:27 +01:00
for (const key of required) {
if (!config.has(key)) {
miss.push(key)
2015-06-09 17:41:40 +02:00
}
}
const redundancyVideos = config.get<any>('redundancy.videos.strategies')
if (isArray(redundancyVideos)) {
for (const r of redundancyVideos) {
if (!r.size) miss.push('redundancy.videos.strategies.size')
if (!r.min_lifetime) miss.push('redundancy.videos.strategies.min_lifetime')
}
}
2018-05-14 17:51:15 +02:00
const missingAlternatives = requiredAlternatives.filter(
set => !set.find(alternative => !alternative.find(key => !config.has(key)))
)
missingAlternatives
.forEach(set => set[0].forEach(key => miss.push(key)))
return miss
}
2017-05-05 17:15:21 +02:00
// Check the available codecs
2017-08-26 09:17:20 +02:00
// We get CONFIG by param to not import it in this file (import orders)
async function checkFFmpeg (CONFIG: { TRANSCODING: { ENABLED: boolean } }) {
2017-05-05 17:15:21 +02:00
const Ffmpeg = require('fluent-ffmpeg')
const getAvailableCodecsPromise = promisify0(Ffmpeg.getAvailableCodecs)
const codecs = await getAvailableCodecsPromise()
const canEncode = [ 'libx264' ]
if (CONFIG.TRANSCODING.ENABLED === false) return undefined
for (const codec of canEncode) {
if (codecs[codec] === undefined) {
throw new Error('Unknown codec ' + codec + ' in FFmpeg.')
}
if (codecs[codec].canEncode !== true) {
throw new Error('Unavailable encode codec ' + codec + ' in FFmpeg')
}
}
2018-10-18 09:44:43 +02:00
return checkFFmpegEncoders()
}
// Optional encoders, if present, can be used to improve transcoding
// Here we ask ffmpeg if it detects their presence on the system, so that we can later use them
let supportedOptionalEncoders: Map<string, boolean>
async function checkFFmpegEncoders (): Promise<Map<string, boolean>> {
if (supportedOptionalEncoders !== undefined) {
return supportedOptionalEncoders
}
const Ffmpeg = require('fluent-ffmpeg')
const getAvailableEncodersPromise = promisify0(Ffmpeg.getAvailableEncoders)
const encoders = await getAvailableEncodersPromise()
const optionalEncoders = [ 'libfdk_aac' ]
supportedOptionalEncoders = new Map<string, boolean>()
for (const encoder of optionalEncoders) {
2018-10-18 09:44:43 +02:00
supportedOptionalEncoders.set(encoder, encoders[encoder] !== undefined)
}
2018-10-18 09:44:43 +02:00
return supportedOptionalEncoders
2017-05-05 17:15:21 +02:00
}
// ---------------------------------------------------------------------------
2016-01-31 11:23:52 +01:00
2017-05-15 22:22:03 +02:00
export {
checkFFmpeg,
checkFFmpegEncoders,
checkMissedConfig
2017-05-15 22:22:03 +02:00
}