PeerTube/server/initializers/checker-before-init.ts

133 lines
6.2 KiB
TypeScript
Raw Normal View History

2021-08-27 14:32:44 +02:00
import { IConfig } from 'config'
2021-03-11 09:51:08 +01:00
import { parseSemVersion, promisify0 } from '../helpers/core-utils'
import { logger } from '../helpers/logger'
2021-08-27 14:32:44 +02:00
// Special behaviour for config because we can reload it
const config: IConfig = require('config')
// ONLY USE CORE MODULES IN THIS FILE!
// Check the config files
function checkMissedConfig () {
const required = [ 'listen.port', 'listen.hostname',
'webserver.https', 'webserver.hostname', 'webserver.port',
2018-03-29 10:58:24 +02:00
'trust_proxy',
2020-12-02 14:23:10 +01:00
'database.hostname', 'database.port', 'database.username', 'database.password', 'database.pool.max',
'smtp.hostname', 'smtp.port', 'smtp.username', 'smtp.password', 'smtp.tls', 'smtp.from_address',
2019-08-22 10:22:01 +02:00
'email.body.signature', 'email.subject.prefix',
'storage.avatars', 'storage.videos', 'storage.logs', 'storage.previews', 'storage.thumbnails', 'storage.torrents', 'storage.cache',
'storage.redundancy', 'storage.tmp', 'storage.streaming_playlists', 'storage.plugins',
'log.level',
'user.video_quota', 'user.video_quota_daily',
'video_channels.max_per_user',
'csp.enabled', 'csp.report_only', 'csp.report_uri',
2021-04-12 15:33:54 +02:00
'security.frameguard.enabled',
'cache.previews.size', 'cache.captions.size', 'cache.torrents.size', 'admin.email', 'contact_form.enabled',
'signup.enabled', 'signup.limit', 'signup.requires_email_verification', 'signup.minimum_age',
'signup.filters.cidr.whitelist', 'signup.filters.cidr.blacklist',
'redundancy.videos.strategies', 'redundancy.videos.check_interval',
'transcoding.enabled', 'transcoding.threads', 'transcoding.allow_additional_extensions', 'transcoding.hls.enabled',
'transcoding.profile', 'transcoding.concurrency',
'transcoding.resolutions.0p', 'transcoding.resolutions.144p', 'transcoding.resolutions.240p', 'transcoding.resolutions.360p',
'transcoding.resolutions.480p', 'transcoding.resolutions.720p', 'transcoding.resolutions.1080p', 'transcoding.resolutions.1440p',
2022-03-22 16:58:49 +01:00
'transcoding.resolutions.2160p', 'video_studio.enabled',
'import.videos.http.enabled', 'import.videos.torrent.enabled', 'import.videos.concurrency', 'auto_blacklist.videos.of_users.enabled',
'trending.videos.interval_days',
'client.videos.miniature.display_author_avatar',
'client.videos.miniature.prefer_author_display_name', 'client.menu.login.redirect_on_single_external_auth',
'defaults.publish.download_enabled', 'defaults.publish.comments_enabled', 'defaults.publish.privacy', 'defaults.publish.licence',
'instance.name', 'instance.short_description', 'instance.description', 'instance.terms', 'instance.default_client_route',
2019-02-20 15:36:43 +01:00
'instance.is_nsfw', 'instance.default_nsfw_policy', 'instance.robots', 'instance.securitytxt',
2019-04-08 14:04:57 +02:00
'services.twitter.username', 'services.twitter.whitelisted',
2019-04-10 09:23:18 +02:00
'followers.instance.enabled', 'followers.instance.manual_approval',
2019-04-11 17:33:36 +02:00
'tracker.enabled', 'tracker.private', 'tracker.reject_too_many_announces',
'history.videos.max_age', 'views.videos.remote.max_age', 'views.videos.local_buffer_update_interval', 'views.videos.ip_view_expiration',
2019-07-09 11:45:19 +02:00
'rates_limit.login.window', 'rates_limit.login.max', 'rates_limit.ask_send_email.window', 'rates_limit.ask_send_email.max',
'theme.default',
'remote_redundancy.videos.accept_from',
'federation.videos.federate_unlisted', 'federation.videos.cleanup_remote_interactions',
2021-03-11 16:54:52 +01:00
'peertube.check_latest_version.enabled', 'peertube.check_latest_version.url',
2020-05-29 16:16:24 +02:00
'search.remote_uri.users', 'search.remote_uri.anonymous', 'search.search_index.enabled', 'search.search_index.url',
2020-09-25 16:19:35 +02:00
'search.search_index.disable_local_search', 'search.search_index.is_default_search',
2022-03-04 13:40:02 +01:00
'live.enabled', 'live.allow_replay', 'live.latency_setting.enabled', 'live.max_duration',
'live.max_user_lives', 'live.max_instance_lives', 'live.rtmp.enabled', 'live.rtmp.port', 'live.rtmp.hostname',
'live.rtmps.enabled', 'live.rtmps.port', 'live.rtmps.hostname', 'live.rtmps.key_file', 'live.rtmps.cert_file',
'live.transcoding.enabled', 'live.transcoding.threads', 'live.transcoding.profile',
'live.transcoding.resolutions.144p', 'live.transcoding.resolutions.240p', 'live.transcoding.resolutions.360p',
'live.transcoding.resolutions.480p', 'live.transcoding.resolutions.720p', 'live.transcoding.resolutions.1080p',
'live.transcoding.resolutions.1440p', 'live.transcoding.resolutions.2160p'
2016-10-13 21:48:55 +02:00
]
2020-09-25 16:19:35 +02:00
2018-05-14 17:51:15 +02:00
const requiredAlternatives = [
[ // set
2020-01-31 16:56:52 +01:00
[ 'redis.hostname', 'redis.port' ], // alternative
[ 'redis.socket' ]
2018-05-14 17:51:15 +02:00
]
]
2017-06-10 22:15:25 +02:00
const miss: string[] = []
2016-03-16 22:29:27 +01:00
for (const key of required) {
if (!config.has(key)) {
miss.push(key)
2015-06-09 17:41:40 +02:00
}
}
const redundancyVideos = config.get<any>('redundancy.videos.strategies')
if (Array.isArray(redundancyVideos)) {
for (const r of redundancyVideos) {
if (!r.size) miss.push('redundancy.videos.strategies.size')
if (!r.min_lifetime) miss.push('redundancy.videos.strategies.min_lifetime')
}
}
2018-05-14 17:51:15 +02:00
const missingAlternatives = requiredAlternatives.filter(
set => !set.find(alternative => !alternative.find(key => !config.has(key)))
)
missingAlternatives
.forEach(set => set[0].forEach(key => miss.push(key)))
return miss
}
2017-05-05 17:15:21 +02:00
// Check the available codecs
2017-08-26 09:17:20 +02:00
// We get CONFIG by param to not import it in this file (import orders)
async function checkFFmpeg (CONFIG: { TRANSCODING: { ENABLED: boolean } }) {
2019-11-05 11:08:51 +01:00
if (CONFIG.TRANSCODING.ENABLED === false) return undefined
2017-05-05 17:15:21 +02:00
const Ffmpeg = require('fluent-ffmpeg')
const getAvailableCodecsPromise = promisify0(Ffmpeg.getAvailableCodecs)
const codecs = await getAvailableCodecsPromise()
const canEncode = [ 'libx264' ]
for (const codec of canEncode) {
if (codecs[codec] === undefined) {
throw new Error('Unknown codec ' + codec + ' in FFmpeg.')
}
if (codecs[codec].canEncode !== true) {
throw new Error('Unavailable encode codec ' + codec + ' in FFmpeg')
}
}
2017-05-05 17:15:21 +02:00
}
function checkNodeVersion () {
const v = process.version
2021-03-11 09:51:08 +01:00
const { major } = parseSemVersion(v)
logger.debug('Checking NodeJS version %s.', v)
2021-12-24 13:52:32 +01:00
if (major <= 12) {
2022-03-01 14:08:03 +01:00
throw new Error('Your NodeJS version ' + v + ' is not supported. Please upgrade.')
2021-12-24 13:52:32 +01:00
}
}
// ---------------------------------------------------------------------------
2016-01-31 11:23:52 +01:00
2017-05-15 22:22:03 +02:00
export {
checkFFmpeg,
checkMissedConfig,
checkNodeVersion
2017-05-15 22:22:03 +02:00
}