]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - server/initializers/checker-before-init.ts
Update client angular
[github/Chocobozzz/PeerTube.git] / server / initializers / checker-before-init.ts
CommitLineData
4d4e5cd4 1import * as config from 'config'
e5565833 2import { promisify0 } from '../helpers/core-utils'
51c35447 3import { logger } from '../helpers/logger'
9f10b292 4
e5565833 5// ONLY USE CORE MODULES IN THIS FILE!
b65c27aa
C
6
7// Check the config files
8function 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
C
36 'theme.default',
37 'remote_redundancy.videos.accept_from'
56835348 38 ]
19f7b248
RK
39 const requiredAlternatives = [
40 [ // set
a1587156
C
41 [ 'redis.hostname', 'redis.port' ], // alternative
42 [ 'redis.socket' ]
19f7b248
RK
43 ]
44 ]
69818c93 45 const miss: string[] = []
9f10b292 46
f0f5567b 47 for (const key of required) {
9f10b292
C
48 if (!config.has(key)) {
49 miss.push(key)
8c308c2b 50 }
8c308c2b
C
51 }
52
e5565833 53 const redundancyVideos = config.get<any>('redundancy.videos.strategies')
d85798c4
C
54
55 if (Array.isArray(redundancyVideos)) {
e5565833
C
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
19f7b248
RK
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
9f10b292
C
69 return miss
70}
71
e5b88539 72// Check the available codecs
3482688c 73// We get CONFIG by param to not import it in this file (import orders)
f5028693 74async function checkFFmpeg (CONFIG: { TRANSCODING: { ENABLED: boolean } }) {
959dbbd7
C
75 if (CONFIG.TRANSCODING.ENABLED === false) return undefined
76
e5b88539 77 const Ffmpeg = require('fluent-ffmpeg')
6fcd19ba 78 const getAvailableCodecsPromise = promisify0(Ffmpeg.getAvailableCodecs)
f5028693 79 const codecs = await getAvailableCodecsPromise()
4176e227
RK
80 const canEncode = [ 'libx264' ]
81
f5028693
C
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 }
4176e227 91
cdf4cb9e 92 return checkFFmpegEncoders()
4176e227
RK
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
97let supportedOptionalEncoders: Map<string, boolean>
98async 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) {
cdf4cb9e 110 supportedOptionalEncoders.set(encoder, encoders[encoder] !== undefined)
4176e227 111 }
cdf4cb9e
C
112
113 return supportedOptionalEncoders
e5b88539
C
114}
115
51c35447
C
116function 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
9f10b292 128// ---------------------------------------------------------------------------
c45f7f84 129
65fcc311 130export {
65fcc311 131 checkFFmpeg,
4176e227 132 checkFFmpegEncoders,
51c35447
C
133 checkMissedConfig,
134 checkNodeVersion
65fcc311 135}