1 import * as config from 'config'
2 import { promisify0 } from '../helpers/core-utils'
4 // ONLY USE CORE MODULES IN THIS FILE!
6 // Check the config files
7 function checkMissedConfig () {
8 const required = [ 'listen.port', 'listen.hostname',
9 'webserver.https', 'webserver.hostname', 'webserver.port',
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 'storage.avatars', 'storage.videos', 'storage.logs', 'storage.previews', 'storage.thumbnails', 'storage.torrents', 'storage.cache',
14 'storage.redundancy', 'storage.tmp', 'storage.streaming_playlists',
16 'user.video_quota', 'user.video_quota_daily',
17 'csp.enabled', 'csp.report_only', 'csp.report_uri',
18 'cache.previews.size', 'admin.email', 'contact_form.enabled',
19 'signup.enabled', 'signup.limit', 'signup.requires_email_verification',
20 'signup.filters.cidr.whitelist', 'signup.filters.cidr.blacklist',
21 'redundancy.videos.strategies', 'redundancy.videos.check_interval',
22 'transcoding.enabled', 'transcoding.threads', 'transcoding.allow_additional_extensions',
23 'import.videos.http.enabled', 'import.videos.torrent.enabled', 'auto_blacklist.videos.of_users.enabled',
24 'trending.videos.interval_days',
25 'instance.name', 'instance.short_description', 'instance.description', 'instance.terms', 'instance.default_client_route',
26 'instance.is_nsfw', 'instance.default_nsfw_policy', 'instance.robots', 'instance.securitytxt',
27 'services.twitter.username', 'services.twitter.whitelisted',
28 'followers.instance.enabled', 'followers.instance.manual_approval',
29 'tracker.enabled', 'tracker.private', 'tracker.reject_too_many_announces'
31 const requiredAlternatives = [
33 ['redis.hostname', 'redis.port'], // alternative
37 const miss: string[] = []
39 for (const key of required) {
40 if (!config.has(key)) {
45 const redundancyVideos = config.get<any>('redundancy.videos.strategies')
47 if (Array.isArray(redundancyVideos)) {
48 for (const r of redundancyVideos) {
49 if (!r.size) miss.push('redundancy.videos.strategies.size')
50 if (!r.min_lifetime) miss.push('redundancy.videos.strategies.min_lifetime')
54 const missingAlternatives = requiredAlternatives.filter(
55 set => !set.find(alternative => !alternative.find(key => !config.has(key)))
59 .forEach(set => set[0].forEach(key => miss.push(key)))
64 // Check the available codecs
65 // We get CONFIG by param to not import it in this file (import orders)
66 async function checkFFmpeg (CONFIG: { TRANSCODING: { ENABLED: boolean } }) {
67 const Ffmpeg = require('fluent-ffmpeg')
68 const getAvailableCodecsPromise = promisify0(Ffmpeg.getAvailableCodecs)
69 const codecs = await getAvailableCodecsPromise()
70 const canEncode = [ 'libx264' ]
72 if (CONFIG.TRANSCODING.ENABLED === false) return undefined
74 for (const codec of canEncode) {
75 if (codecs[codec] === undefined) {
76 throw new Error('Unknown codec ' + codec + ' in FFmpeg.')
79 if (codecs[codec].canEncode !== true) {
80 throw new Error('Unavailable encode codec ' + codec + ' in FFmpeg')
84 return checkFFmpegEncoders()
87 // Optional encoders, if present, can be used to improve transcoding
88 // Here we ask ffmpeg if it detects their presence on the system, so that we can later use them
89 let supportedOptionalEncoders: Map<string, boolean>
90 async function checkFFmpegEncoders (): Promise<Map<string, boolean>> {
91 if (supportedOptionalEncoders !== undefined) {
92 return supportedOptionalEncoders
95 const Ffmpeg = require('fluent-ffmpeg')
96 const getAvailableEncodersPromise = promisify0(Ffmpeg.getAvailableEncoders)
97 const encoders = await getAvailableEncodersPromise()
98 const optionalEncoders = [ 'libfdk_aac' ]
99 supportedOptionalEncoders = new Map<string, boolean>()
101 for (const encoder of optionalEncoders) {
102 supportedOptionalEncoders.set(encoder, encoders[encoder] !== undefined)
105 return supportedOptionalEncoders
108 // ---------------------------------------------------------------------------