]>
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 | 37 | 'remote_redundancy.videos.accept_from', |
5fb2e288 C |
38 | 'federation.videos.federate_unlisted', |
39 | 'search.remote_uri.users', 'search.remote_uri.anonymous', 'search.search_index.enabled', 'search.search_index.url', | |
fb719404 | 40 | 'search.search_index.disable_local_search', 'search.search_index.is_default_search', |
a056ca48 | 41 | 'live.enabled', 'live.allow_replay', 'live.max_duration', 'live.max_user_lives', 'live.max_instance_lives', |
fb719404 C |
42 | 'live.transcoding.enabled', 'live.transcoding.threads', |
43 | 'live.transcoding.resolutions.240p', 'live.transcoding.resolutions.360p', 'live.transcoding.resolutions.480p', | |
44 | 'live.transcoding.resolutions.720p', 'live.transcoding.resolutions.1080p', 'live.transcoding.resolutions.2160p' | |
56835348 | 45 | ] |
fb719404 | 46 | |
19f7b248 RK |
47 | const requiredAlternatives = [ |
48 | [ // set | |
a1587156 C |
49 | [ 'redis.hostname', 'redis.port' ], // alternative |
50 | [ 'redis.socket' ] | |
19f7b248 RK |
51 | ] |
52 | ] | |
69818c93 | 53 | const miss: string[] = [] |
9f10b292 | 54 | |
f0f5567b | 55 | for (const key of required) { |
9f10b292 C |
56 | if (!config.has(key)) { |
57 | miss.push(key) | |
8c308c2b | 58 | } |
8c308c2b C |
59 | } |
60 | ||
e5565833 | 61 | const redundancyVideos = config.get<any>('redundancy.videos.strategies') |
d85798c4 C |
62 | |
63 | if (Array.isArray(redundancyVideos)) { | |
e5565833 C |
64 | for (const r of redundancyVideos) { |
65 | if (!r.size) miss.push('redundancy.videos.strategies.size') | |
66 | if (!r.min_lifetime) miss.push('redundancy.videos.strategies.min_lifetime') | |
67 | } | |
68 | } | |
69 | ||
19f7b248 RK |
70 | const missingAlternatives = requiredAlternatives.filter( |
71 | set => !set.find(alternative => !alternative.find(key => !config.has(key))) | |
72 | ) | |
73 | ||
74 | missingAlternatives | |
75 | .forEach(set => set[0].forEach(key => miss.push(key))) | |
76 | ||
9f10b292 C |
77 | return miss |
78 | } | |
79 | ||
e5b88539 | 80 | // Check the available codecs |
3482688c | 81 | // We get CONFIG by param to not import it in this file (import orders) |
f5028693 | 82 | async function checkFFmpeg (CONFIG: { TRANSCODING: { ENABLED: boolean } }) { |
959dbbd7 C |
83 | if (CONFIG.TRANSCODING.ENABLED === false) return undefined |
84 | ||
e5b88539 | 85 | const Ffmpeg = require('fluent-ffmpeg') |
6fcd19ba | 86 | const getAvailableCodecsPromise = promisify0(Ffmpeg.getAvailableCodecs) |
f5028693 | 87 | const codecs = await getAvailableCodecsPromise() |
4176e227 RK |
88 | const canEncode = [ 'libx264' ] |
89 | ||
f5028693 C |
90 | for (const codec of canEncode) { |
91 | if (codecs[codec] === undefined) { | |
92 | throw new Error('Unknown codec ' + codec + ' in FFmpeg.') | |
93 | } | |
94 | ||
95 | if (codecs[codec].canEncode !== true) { | |
96 | throw new Error('Unavailable encode codec ' + codec + ' in FFmpeg') | |
97 | } | |
98 | } | |
4176e227 | 99 | |
cdf4cb9e | 100 | return checkFFmpegEncoders() |
4176e227 RK |
101 | } |
102 | ||
9252a33d C |
103 | // Detect supported encoders by ffmpeg |
104 | let supportedEncoders: Map<string, boolean> | |
4176e227 | 105 | async function checkFFmpegEncoders (): Promise<Map<string, boolean>> { |
9252a33d C |
106 | if (supportedEncoders !== undefined) { |
107 | return supportedEncoders | |
4176e227 RK |
108 | } |
109 | ||
110 | const Ffmpeg = require('fluent-ffmpeg') | |
111 | const getAvailableEncodersPromise = promisify0(Ffmpeg.getAvailableEncoders) | |
9252a33d C |
112 | const availableEncoders = await getAvailableEncodersPromise() |
113 | ||
114 | const searchEncoders = [ | |
115 | 'aac', | |
116 | 'libfdk_aac', | |
117 | 'libx264' | |
118 | ] | |
119 | ||
120 | supportedEncoders = new Map<string, boolean>() | |
4176e227 | 121 | |
9252a33d C |
122 | for (const searchEncoder of searchEncoders) { |
123 | supportedEncoders.set(searchEncoder, availableEncoders[searchEncoder] !== undefined) | |
4176e227 | 124 | } |
cdf4cb9e | 125 | |
9252a33d | 126 | return supportedEncoders |
e5b88539 C |
127 | } |
128 | ||
51c35447 C |
129 | function checkNodeVersion () { |
130 | const v = process.version | |
131 | const majorString = v.split('.')[0].replace('v', '') | |
132 | const major = parseInt(majorString, 10) | |
133 | ||
134 | logger.debug('Checking NodeJS version %s.', v) | |
135 | ||
136 | if (major < 10) { | |
137 | logger.warn('Your NodeJS version %s is deprecated. Please use Node 10.', v) | |
138 | } | |
139 | } | |
140 | ||
9f10b292 | 141 | // --------------------------------------------------------------------------- |
c45f7f84 | 142 | |
65fcc311 | 143 | export { |
65fcc311 | 144 | checkFFmpeg, |
4176e227 | 145 | checkFFmpegEncoders, |
51c35447 C |
146 | checkMissedConfig, |
147 | checkNodeVersion | |
65fcc311 | 148 | } |