1 import * as config from 'config'
2 import { promisify0 } from '../helpers/core-utils'
3 import { logger } from '../helpers/logger'
5 // ONLY USE CORE MODULES IN THIS FILE!
7 // Check the config files
8 function checkMissedConfig () {
9 const required = [ 'listen.port', 'listen.hostname',
10 'webserver.https', 'webserver.hostname', 'webserver.port',
12 'database.hostname', 'database.port', 'database.suffix', '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',
18 'user.video_quota', 'user.video_quota_daily',
19 'csp.enabled', 'csp.report_only', 'csp.report_uri',
20 'cache.previews.size', 'admin.email', 'contact_form.enabled',
21 'signup.enabled', 'signup.limit', 'signup.requires_email_verification',
22 'signup.filters.cidr.whitelist', 'signup.filters.cidr.blacklist',
23 'redundancy.videos.strategies', 'redundancy.videos.check_interval',
24 'transcoding.enabled', 'transcoding.threads', 'transcoding.allow_additional_extensions', 'transcoding.hls.enabled',
25 'transcoding.resolutions.0p', 'transcoding.resolutions.240p', 'transcoding.resolutions.360p', 'transcoding.resolutions.480p',
26 'transcoding.resolutions.720p', 'transcoding.resolutions.1080p', 'transcoding.resolutions.2160p',
27 'import.videos.http.enabled', 'import.videos.torrent.enabled', 'auto_blacklist.videos.of_users.enabled',
28 'trending.videos.interval_days',
29 'instance.name', 'instance.short_description', 'instance.description', 'instance.terms', 'instance.default_client_route',
30 'instance.is_nsfw', 'instance.default_nsfw_policy', 'instance.robots', 'instance.securitytxt',
31 'services.twitter.username', 'services.twitter.whitelisted',
32 'followers.instance.enabled', 'followers.instance.manual_approval',
33 'tracker.enabled', 'tracker.private', 'tracker.reject_too_many_announces',
34 'history.videos.max_age', 'views.videos.remote.max_age',
35 'rates_limit.login.window', 'rates_limit.login.max', 'rates_limit.ask_send_email.window', 'rates_limit.ask_send_email.max',
37 'remote_redundancy.videos.accept_from',
38 'federation.videos.federate_unlisted',
39 'search.remote_uri.users', 'search.remote_uri.anonymous', 'search.search_index.enabled', 'search.search_index.url',
40 'search.search_index.disable_local_search', 'search.search_index.is_default_search'
42 const requiredAlternatives = [
44 [ 'redis.hostname', 'redis.port' ], // alternative
48 const miss: string[] = []
50 for (const key of required) {
51 if (!config.has(key)) {
56 const redundancyVideos = config.get<any>('redundancy.videos.strategies')
58 if (Array.isArray(redundancyVideos)) {
59 for (const r of redundancyVideos) {
60 if (!r.size) miss.push('redundancy.videos.strategies.size')
61 if (!r.min_lifetime) miss.push('redundancy.videos.strategies.min_lifetime')
65 const missingAlternatives = requiredAlternatives.filter(
66 set => !set.find(alternative => !alternative.find(key => !config.has(key)))
70 .forEach(set => set[0].forEach(key => miss.push(key)))
75 // Check the available codecs
76 // We get CONFIG by param to not import it in this file (import orders)
77 async function checkFFmpeg (CONFIG: { TRANSCODING: { ENABLED: boolean } }) {
78 if (CONFIG.TRANSCODING.ENABLED === false) return undefined
80 const Ffmpeg = require('fluent-ffmpeg')
81 const getAvailableCodecsPromise = promisify0(Ffmpeg.getAvailableCodecs)
82 const codecs = await getAvailableCodecsPromise()
83 const canEncode = [ 'libx264' ]
85 for (const codec of canEncode) {
86 if (codecs[codec] === undefined) {
87 throw new Error('Unknown codec ' + codec + ' in FFmpeg.')
90 if (codecs[codec].canEncode !== true) {
91 throw new Error('Unavailable encode codec ' + codec + ' in FFmpeg')
95 return checkFFmpegEncoders()
98 // Optional encoders, if present, can be used to improve transcoding
99 // Here we ask ffmpeg if it detects their presence on the system, so that we can later use them
100 let supportedOptionalEncoders: Map<string, boolean>
101 async function checkFFmpegEncoders (): Promise<Map<string, boolean>> {
102 if (supportedOptionalEncoders !== undefined) {
103 return supportedOptionalEncoders
106 const Ffmpeg = require('fluent-ffmpeg')
107 const getAvailableEncodersPromise = promisify0(Ffmpeg.getAvailableEncoders)
108 const encoders = await getAvailableEncodersPromise()
109 const optionalEncoders = [ 'libfdk_aac' ]
110 supportedOptionalEncoders = new Map<string, boolean>()
112 for (const encoder of optionalEncoders) {
113 supportedOptionalEncoders.set(encoder, encoders[encoder] !== undefined)
116 return supportedOptionalEncoders
119 function checkNodeVersion () {
120 const v = process.version
121 const majorString = v.split('.')[0].replace('v', '')
122 const major = parseInt(majorString, 10)
124 logger.debug('Checking NodeJS version %s.', v)
127 logger.warn('Your NodeJS version %s is deprecated. Please use Node 10.', v)
131 // ---------------------------------------------------------------------------