]>
Commit | Line | Data |
---|---|---|
1 | import * as config from 'config' | |
2 | import { promisify0 } from '../helpers/core-utils' | |
3 | import { logger } from '../helpers/logger' | |
4 | ||
5 | // ONLY USE CORE MODULES IN THIS FILE! | |
6 | ||
7 | // Check the config files | |
8 | function checkMissedConfig () { | |
9 | const required = [ 'listen.port', 'listen.hostname', | |
10 | 'webserver.https', 'webserver.hostname', 'webserver.port', | |
11 | 'trust_proxy', | |
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', | |
17 | 'log.level', | |
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', | |
36 | 'theme.default', | |
37 | 'remote_redundancy.videos.accept_from' | |
38 | ] | |
39 | const requiredAlternatives = [ | |
40 | [ // set | |
41 | [ 'redis.hostname', 'redis.port' ], // alternative | |
42 | [ 'redis.socket' ] | |
43 | ] | |
44 | ] | |
45 | const miss: string[] = [] | |
46 | ||
47 | for (const key of required) { | |
48 | if (!config.has(key)) { | |
49 | miss.push(key) | |
50 | } | |
51 | } | |
52 | ||
53 | const redundancyVideos = config.get<any>('redundancy.videos.strategies') | |
54 | ||
55 | if (Array.isArray(redundancyVideos)) { | |
56 | for (const r of redundancyVideos) { | |
57 | if (!r.size) miss.push('redundancy.videos.strategies.size') | |
58 | if (!r.min_lifetime) miss.push('redundancy.videos.strategies.min_lifetime') | |
59 | } | |
60 | } | |
61 | ||
62 | const missingAlternatives = requiredAlternatives.filter( | |
63 | set => !set.find(alternative => !alternative.find(key => !config.has(key))) | |
64 | ) | |
65 | ||
66 | missingAlternatives | |
67 | .forEach(set => set[0].forEach(key => miss.push(key))) | |
68 | ||
69 | return miss | |
70 | } | |
71 | ||
72 | // Check the available codecs | |
73 | // We get CONFIG by param to not import it in this file (import orders) | |
74 | async function checkFFmpeg (CONFIG: { TRANSCODING: { ENABLED: boolean } }) { | |
75 | if (CONFIG.TRANSCODING.ENABLED === false) return undefined | |
76 | ||
77 | const Ffmpeg = require('fluent-ffmpeg') | |
78 | const getAvailableCodecsPromise = promisify0(Ffmpeg.getAvailableCodecs) | |
79 | const codecs = await getAvailableCodecsPromise() | |
80 | const canEncode = [ 'libx264' ] | |
81 | ||
82 | for (const codec of canEncode) { | |
83 | if (codecs[codec] === undefined) { | |
84 | throw new Error('Unknown codec ' + codec + ' in FFmpeg.') | |
85 | } | |
86 | ||
87 | if (codecs[codec].canEncode !== true) { | |
88 | throw new Error('Unavailable encode codec ' + codec + ' in FFmpeg') | |
89 | } | |
90 | } | |
91 | ||
92 | return checkFFmpegEncoders() | |
93 | } | |
94 | ||
95 | // Optional encoders, if present, can be used to improve transcoding | |
96 | // Here we ask ffmpeg if it detects their presence on the system, so that we can later use them | |
97 | let supportedOptionalEncoders: Map<string, boolean> | |
98 | async function checkFFmpegEncoders (): Promise<Map<string, boolean>> { | |
99 | if (supportedOptionalEncoders !== undefined) { | |
100 | return supportedOptionalEncoders | |
101 | } | |
102 | ||
103 | const Ffmpeg = require('fluent-ffmpeg') | |
104 | const getAvailableEncodersPromise = promisify0(Ffmpeg.getAvailableEncoders) | |
105 | const encoders = await getAvailableEncodersPromise() | |
106 | const optionalEncoders = [ 'libfdk_aac' ] | |
107 | supportedOptionalEncoders = new Map<string, boolean>() | |
108 | ||
109 | for (const encoder of optionalEncoders) { | |
110 | supportedOptionalEncoders.set(encoder, encoders[encoder] !== undefined) | |
111 | } | |
112 | ||
113 | return supportedOptionalEncoders | |
114 | } | |
115 | ||
116 | function checkNodeVersion () { | |
117 | const v = process.version | |
118 | const majorString = v.split('.')[0].replace('v', '') | |
119 | const major = parseInt(majorString, 10) | |
120 | ||
121 | logger.debug('Checking NodeJS version %s.', v) | |
122 | ||
123 | if (major < 10) { | |
124 | logger.warn('Your NodeJS version %s is deprecated. Please use Node 10.', v) | |
125 | } | |
126 | } | |
127 | ||
128 | // --------------------------------------------------------------------------- | |
129 | ||
130 | export { | |
131 | checkFFmpeg, | |
132 | checkFFmpegEncoders, | |
133 | checkMissedConfig, | |
134 | checkNodeVersion | |
135 | } |