]>
Commit | Line | Data |
---|---|---|
4d4e5cd4 | 1 | import * as config from 'config' |
e5565833 | 2 | import { promisify0 } from '../helpers/core-utils' |
51c35447 | 3 | import { logger } from '../helpers/logger' |
9f10b292 | 4 | |
e5565833 | 5 | // ONLY USE CORE MODULES IN THIS FILE! |
b65c27aa C |
6 | |
7 | // Check the config files | |
8 | function checkMissedConfig () { | |
cff8b272 | 9 | const required = [ 'listen.port', 'listen.hostname', |
3737bbaf | 10 | 'webserver.https', 'webserver.hostname', 'webserver.port', |
490b595a | 11 | 'trust_proxy', |
1c3386e8 | 12 | 'database.hostname', 'database.port', 'database.suffix', 'database.username', 'database.password', 'database.pool.max', |
a465bf5f | 13 | 'smtp.hostname', 'smtp.port', 'smtp.username', 'smtp.password', 'smtp.tls', 'smtp.from_address', |
916937d7 | 14 | 'email.body.signature', 'email.subject.prefix', |
a465bf5f | 15 | 'storage.avatars', 'storage.videos', 'storage.logs', 'storage.previews', 'storage.thumbnails', 'storage.torrents', 'storage.cache', |
345da516 | 16 | 'storage.redundancy', 'storage.tmp', 'storage.streaming_playlists', 'storage.plugins', |
a465bf5f | 17 | 'log.level', |
bee0abff | 18 | 'user.video_quota', 'user.video_quota_daily', |
539d3f4f | 19 | 'csp.enabled', 'csp.report_only', 'csp.report_uri', |
d3e56c0c | 20 | 'cache.previews.size', 'admin.email', 'contact_form.enabled', |
d9eaee39 JM |
21 | 'signup.enabled', 'signup.limit', 'signup.requires_email_verification', |
22 | 'signup.filters.cidr.whitelist', 'signup.filters.cidr.blacklist', | |
f9f899b9 | 23 | 'redundancy.videos.strategies', 'redundancy.videos.check_interval', |
5d9e4eaa | 24 | 'transcoding.enabled', 'transcoding.threads', 'transcoding.allow_additional_extensions', 'transcoding.hls.enabled', |
7cbbf79f C |
25 | 'transcoding.resolutions.0p', 'transcoding.resolutions.240p', 'transcoding.resolutions.360p', 'transcoding.resolutions.480p', |
26 | 'transcoding.resolutions.720p', 'transcoding.resolutions.1080p', 'transcoding.resolutions.2160p', | |
7ccddd7b | 27 | 'import.videos.http.enabled', 'import.videos.torrent.enabled', 'auto_blacklist.videos.of_users.enabled', |
df39a683 | 28 | 'trending.videos.interval_days', |
0883b324 | 29 | 'instance.name', 'instance.short_description', 'instance.description', 'instance.terms', 'instance.default_client_route', |
f8802489 | 30 | 'instance.is_nsfw', 'instance.default_nsfw_policy', 'instance.robots', 'instance.securitytxt', |
5b9c965d | 31 | 'services.twitter.username', 'services.twitter.whitelisted', |
31b6ddf8 | 32 | 'followers.instance.enabled', 'followers.instance.manual_approval', |
cda03765 | 33 | 'tracker.enabled', 'tracker.private', 'tracker.reject_too_many_announces', |
c342726a | 34 | 'history.videos.max_age', 'views.videos.remote.max_age', |
7cd4d2ba | 35 | 'rates_limit.login.window', 'rates_limit.login.max', 'rates_limit.ask_send_email.window', 'rates_limit.ask_send_email.max', |
8c9e7875 | 36 | 'theme.default', |
3092e9bb LB |
37 | 'remote_redundancy.videos.accept_from', |
38 | 'federation.videos.federate_unlisted' | |
56835348 | 39 | ] |
19f7b248 RK |
40 | const requiredAlternatives = [ |
41 | [ // set | |
a1587156 C |
42 | [ 'redis.hostname', 'redis.port' ], // alternative |
43 | [ 'redis.socket' ] | |
19f7b248 RK |
44 | ] |
45 | ] | |
69818c93 | 46 | const miss: string[] = [] |
9f10b292 | 47 | |
f0f5567b | 48 | for (const key of required) { |
9f10b292 C |
49 | if (!config.has(key)) { |
50 | miss.push(key) | |
8c308c2b | 51 | } |
8c308c2b C |
52 | } |
53 | ||
e5565833 | 54 | const redundancyVideos = config.get<any>('redundancy.videos.strategies') |
d85798c4 C |
55 | |
56 | if (Array.isArray(redundancyVideos)) { | |
e5565833 C |
57 | for (const r of redundancyVideos) { |
58 | if (!r.size) miss.push('redundancy.videos.strategies.size') | |
59 | if (!r.min_lifetime) miss.push('redundancy.videos.strategies.min_lifetime') | |
60 | } | |
61 | } | |
62 | ||
19f7b248 RK |
63 | const missingAlternatives = requiredAlternatives.filter( |
64 | set => !set.find(alternative => !alternative.find(key => !config.has(key))) | |
65 | ) | |
66 | ||
67 | missingAlternatives | |
68 | .forEach(set => set[0].forEach(key => miss.push(key))) | |
69 | ||
9f10b292 C |
70 | return miss |
71 | } | |
72 | ||
e5b88539 | 73 | // Check the available codecs |
3482688c | 74 | // We get CONFIG by param to not import it in this file (import orders) |
f5028693 | 75 | async function checkFFmpeg (CONFIG: { TRANSCODING: { ENABLED: boolean } }) { |
959dbbd7 C |
76 | if (CONFIG.TRANSCODING.ENABLED === false) return undefined |
77 | ||
e5b88539 | 78 | const Ffmpeg = require('fluent-ffmpeg') |
6fcd19ba | 79 | const getAvailableCodecsPromise = promisify0(Ffmpeg.getAvailableCodecs) |
f5028693 | 80 | const codecs = await getAvailableCodecsPromise() |
4176e227 RK |
81 | const canEncode = [ 'libx264' ] |
82 | ||
f5028693 C |
83 | for (const codec of canEncode) { |
84 | if (codecs[codec] === undefined) { | |
85 | throw new Error('Unknown codec ' + codec + ' in FFmpeg.') | |
86 | } | |
87 | ||
88 | if (codecs[codec].canEncode !== true) { | |
89 | throw new Error('Unavailable encode codec ' + codec + ' in FFmpeg') | |
90 | } | |
91 | } | |
4176e227 | 92 | |
cdf4cb9e | 93 | return checkFFmpegEncoders() |
4176e227 RK |
94 | } |
95 | ||
96 | // Optional encoders, if present, can be used to improve transcoding | |
97 | // Here we ask ffmpeg if it detects their presence on the system, so that we can later use them | |
98 | let supportedOptionalEncoders: Map<string, boolean> | |
99 | async function checkFFmpegEncoders (): Promise<Map<string, boolean>> { | |
100 | if (supportedOptionalEncoders !== undefined) { | |
101 | return supportedOptionalEncoders | |
102 | } | |
103 | ||
104 | const Ffmpeg = require('fluent-ffmpeg') | |
105 | const getAvailableEncodersPromise = promisify0(Ffmpeg.getAvailableEncoders) | |
106 | const encoders = await getAvailableEncodersPromise() | |
107 | const optionalEncoders = [ 'libfdk_aac' ] | |
108 | supportedOptionalEncoders = new Map<string, boolean>() | |
109 | ||
110 | for (const encoder of optionalEncoders) { | |
cdf4cb9e | 111 | supportedOptionalEncoders.set(encoder, encoders[encoder] !== undefined) |
4176e227 | 112 | } |
cdf4cb9e C |
113 | |
114 | return supportedOptionalEncoders | |
e5b88539 C |
115 | } |
116 | ||
51c35447 C |
117 | function checkNodeVersion () { |
118 | const v = process.version | |
119 | const majorString = v.split('.')[0].replace('v', '') | |
120 | const major = parseInt(majorString, 10) | |
121 | ||
122 | logger.debug('Checking NodeJS version %s.', v) | |
123 | ||
124 | if (major < 10) { | |
125 | logger.warn('Your NodeJS version %s is deprecated. Please use Node 10.', v) | |
126 | } | |
127 | } | |
128 | ||
9f10b292 | 129 | // --------------------------------------------------------------------------- |
c45f7f84 | 130 | |
65fcc311 | 131 | export { |
65fcc311 | 132 | checkFFmpeg, |
4176e227 | 133 | checkFFmpegEncoders, |
51c35447 C |
134 | checkMissedConfig, |
135 | checkNodeVersion | |
65fcc311 | 136 | } |