1
0
Fork 0
peertube/server/initializers/checker-before-init.ts

123 lines
5.4 KiB
TypeScript
Raw Normal View History

2017-06-05 15:53:49 -04:00
import * as config from 'config'
2021-03-11 03:51:08 -05:00
import { parseSemVersion, promisify0 } from '../helpers/core-utils'
import { logger } from '../helpers/logger'
// 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 04:58:24 -04:00
'trust_proxy',
2020-12-02 08:23:10 -05: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 04:22:01 -04: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',
'csp.enabled', 'csp.report_only', 'csp.report_uri',
2021-04-12 09:33:54 -04: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',
2020-04-10 02:55:21 -04:00
'transcoding.resolutions.0p', 'transcoding.resolutions.240p', 'transcoding.resolutions.360p', 'transcoding.resolutions.480p',
'transcoding.resolutions.720p', 'transcoding.resolutions.1080p', 'transcoding.resolutions.1440p', 'transcoding.resolutions.2160p',
'import.videos.http.enabled', 'import.videos.torrent.enabled', 'import.videos.concurrency', 'auto_blacklist.videos.of_users.enabled',
'trending.videos.interval_days',
'instance.name', 'instance.short_description', 'instance.description', 'instance.terms', 'instance.default_client_route',
2019-02-20 09:36:43 -05:00
'instance.is_nsfw', 'instance.default_nsfw_policy', 'instance.robots', 'instance.securitytxt',
2019-04-08 08:04:57 -04:00
'services.twitter.username', 'services.twitter.whitelisted',
2019-04-10 03:23:18 -04:00
'followers.instance.enabled', 'followers.instance.manual_approval',
2019-04-11 11:33:36 -04:00
'tracker.enabled', 'tracker.private', 'tracker.reject_too_many_announces',
'history.videos.max_age', 'views.videos.remote.max_age',
2019-07-09 05:45:19 -04: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 10:54:52 -05:00
'peertube.check_latest_version.enabled', 'peertube.check_latest_version.url',
2020-05-29 10:16:24 -04:00
'search.remote_uri.users', 'search.remote_uri.anonymous', 'search.search_index.enabled', 'search.search_index.url',
2020-09-25 10:19:35 -04:00
'search.search_index.disable_local_search', 'search.search_index.is_default_search',
2020-10-28 10:24:40 -04:00
'live.enabled', 'live.allow_replay', 'live.max_duration', 'live.max_user_lives', 'live.max_instance_lives',
'live.transcoding.enabled', 'live.transcoding.threads', 'live.transcoding.profile',
2020-09-25 10:19:35 -04:00
'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 15:48:55 -04:00
]
2020-09-25 10:19:35 -04:00
2018-05-14 11:51:15 -04:00
const requiredAlternatives = [
[ // set
2020-01-31 10:56:52 -05:00
[ 'redis.hostname', 'redis.port' ], // alternative
[ 'redis.socket' ]
2018-05-14 11:51:15 -04:00
]
]
2017-06-10 16:15:25 -04:00
const miss: string[] = []
2016-03-16 17:29:27 -04:00
for (const key of required) {
if (!config.has(key)) {
miss.push(key)
2015-06-09 11:41:40 -04: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 11:51:15 -04: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 11:15:21 -04:00
// Check the available codecs
2017-08-26 03:17:20 -04: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 05:08:51 -05:00
if (CONFIG.TRANSCODING.ENABLED === false) return undefined
2017-05-05 11:15:21 -04: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 11:15:21 -04:00
}
function checkNodeVersion () {
const v = process.version
2021-03-11 03:51:08 -05:00
const { major } = parseSemVersion(v)
logger.debug('Checking NodeJS version %s.', v)
if (major <= 10) {
logger.warn('Your NodeJS version %s is deprecated. Please upgrade.', v)
}
}
// ---------------------------------------------------------------------------
2016-01-31 05:23:52 -05:00
2017-05-15 16:22:03 -04:00
export {
checkFFmpeg,
checkMissedConfig,
checkNodeVersion
2017-05-15 16:22:03 -04:00
}