-import * as config from 'config'
-import { uniq } from 'lodash'
+import config from 'config'
import { URL } from 'url'
-import { getFFmpegVersion } from '@server/helpers/ffmpeg-utils'
+import { getFFmpegVersion } from '@server/helpers/ffmpeg'
+import { uniqify } from '@shared/core-utils'
import { VideoRedundancyConfigFilter } from '@shared/models/redundancy/video-redundancy-config-filter.type'
import { RecentlyAddedStrategy } from '../../shared/models/redundancy'
-import { isProdInstance, isTestInstance, parseSemVersion } from '../helpers/core-utils'
+import { isProdInstance, parseSemVersion } from '../helpers/core-utils'
import { isArray } from '../helpers/custom-validators/misc'
import { logger } from '../helpers/logger'
-import { UserModel } from '../models/account/user'
import { ApplicationModel, getServerActor } from '../models/application/application'
import { OAuthClientModel } from '../models/oauth/oauth-client'
+import { UserModel } from '../models/user/user'
import { CONFIG, isEmailEnabled } from './config'
import { WEBSERVER } from './constants'
}
}
-// Some checks on configuration files
-// Return an error message, or null if everything is okay
+// Some checks on configuration files or throw if there is an error
function checkConfig () {
+ const configFiles = config.util.getConfigSources().map(s => s.name).join(' -> ')
+ logger.info('Using following configuration file hierarchy: %s.', configFiles)
+
// Moved configuration keys
if (config.has('services.csp-logger')) {
logger.warn('services.csp-logger configuration has been renamed to csp.report_uri. Please update your configuration file.')
}
- // Email verification
+ checkSecretsConfig()
+ checkEmailConfig()
+ checkNSFWPolicyConfig()
+ checkLocalRedundancyConfig()
+ checkRemoteRedundancyConfig()
+ checkStorageConfig()
+ checkTranscodingConfig()
+ checkImportConfig()
+ checkBroadcastMessageConfig()
+ checkSearchConfig()
+ checkLiveConfig()
+ checkObjectStorageConfig()
+ checkVideoStudioConfig()
+}
+
+// We get db by param to not import it in this file (import orders)
+async function clientsExist () {
+ const totalClients = await OAuthClientModel.countTotal()
+
+ return totalClients !== 0
+}
+
+// We get db by param to not import it in this file (import orders)
+async function usersExist () {
+ const totalUsers = await UserModel.countTotal()
+
+ return totalUsers !== 0
+}
+
+// We get db by param to not import it in this file (import orders)
+async function applicationExist () {
+ const totalApplication = await ApplicationModel.countTotal()
+
+ return totalApplication !== 0
+}
+
+async function checkFFmpegVersion () {
+ const version = await getFFmpegVersion()
+ const { major, minor, patch } = parseSemVersion(version)
+
+ if (major < 4 || (major === 4 && minor < 1)) {
+ logger.warn('Your ffmpeg version (%s) is outdated. PeerTube supports ffmpeg >= 4.1. Please upgrade ffmpeg.', version)
+ }
+
+ if (major === 4 && minor === 4 && patch === 0) {
+ logger.warn('There is a bug in ffmpeg 4.4.0 with HLS videos. Please upgrade ffmpeg.')
+ }
+}
+
+// ---------------------------------------------------------------------------
+
+export {
+ checkConfig,
+ clientsExist,
+ checkFFmpegVersion,
+ usersExist,
+ applicationExist,
+ checkActivityPubUrls
+}
+
+// ---------------------------------------------------------------------------
+
+function checkSecretsConfig () {
+ if (!CONFIG.SECRETS.PEERTUBE) {
+ throw new Error('secrets.peertube is missing in config. Generate one using `openssl rand -hex 32`')
+ }
+}
+
+function checkEmailConfig () {
if (!isEmailEnabled()) {
if (CONFIG.SIGNUP.ENABLED && CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
- return 'Emailer is disabled but you require signup email verification.'
+ throw new Error('Emailer is disabled but you require signup email verification.')
}
if (CONFIG.CONTACT_FORM.ENABLED) {
logger.warn('Emailer is disabled so the contact form will not work.')
}
}
+}
- // NSFW policy
+function checkNSFWPolicyConfig () {
const defaultNSFWPolicy = CONFIG.INSTANCE.DEFAULT_NSFW_POLICY
- {
- const available = [ 'do_not_list', 'blur', 'display' ]
- if (available.includes(defaultNSFWPolicy) === false) {
- return 'NSFW policy setting should be ' + available.join(' or ') + ' instead of ' + defaultNSFWPolicy
- }
+
+ const available = [ 'do_not_list', 'blur', 'display' ]
+ if (available.includes(defaultNSFWPolicy) === false) {
+ throw new Error('NSFW policy setting should be ' + available.join(' or ') + ' instead of ' + defaultNSFWPolicy)
}
+}
- // Redundancies
+function checkLocalRedundancyConfig () {
const redundancyVideos = CONFIG.REDUNDANCY.VIDEOS.STRATEGIES
+
if (isArray(redundancyVideos)) {
const available = [ 'most-views', 'trending', 'recently-added' ]
+
for (const r of redundancyVideos) {
if (available.includes(r.strategy) === false) {
- return 'Videos redundancy should have ' + available.join(' or ') + ' strategy instead of ' + r.strategy
+ throw new Error('Videos redundancy should have ' + available.join(' or ') + ' strategy instead of ' + r.strategy)
}
// Lifetime should not be < 10 hours
- if (!isTestInstance() && r.minLifetime < 1000 * 3600 * 10) {
- return 'Video redundancy minimum lifetime should be >= 10 hours for strategy ' + r.strategy
+ if (isProdInstance() && r.minLifetime < 1000 * 3600 * 10) {
+ throw new Error('Video redundancy minimum lifetime should be >= 10 hours for strategy ' + r.strategy)
}
}
- const filtered = uniq(redundancyVideos.map(r => r.strategy))
+ const filtered = uniqify(redundancyVideos.map(r => r.strategy))
if (filtered.length !== redundancyVideos.length) {
- return 'Redundancy video entries should have unique strategies'
+ throw new Error('Redundancy video entries should have unique strategies')
}
const recentlyAddedStrategy = redundancyVideos.find(r => r.strategy === 'recently-added') as RecentlyAddedStrategy
if (recentlyAddedStrategy && isNaN(recentlyAddedStrategy.minViews)) {
- return 'Min views in recently added strategy is not a number'
+ throw new Error('Min views in recently added strategy is not a number')
}
} else {
- return 'Videos redundancy should be an array (you must uncomment lines containing - too)'
+ throw new Error('Videos redundancy should be an array (you must uncomment lines containing - too)')
}
+}
- // Remote redundancies
+function checkRemoteRedundancyConfig () {
const acceptFrom = CONFIG.REMOTE_REDUNDANCY.VIDEOS.ACCEPT_FROM
const acceptFromValues = new Set<VideoRedundancyConfigFilter>([ 'nobody', 'anybody', 'followings' ])
+
if (acceptFromValues.has(acceptFrom) === false) {
- return 'remote_redundancy.videos.accept_from has an incorrect value'
+ throw new Error('remote_redundancy.videos.accept_from has an incorrect value')
}
+}
+function checkStorageConfig () {
// Check storage directory locations
if (isProdInstance()) {
const configStorage = config.get('storage')
if (CONFIG.STORAGE.VIDEOS_DIR === CONFIG.STORAGE.REDUNDANCY_DIR) {
logger.warn('Redundancy directory should be different than the videos folder.')
}
+}
- // Transcoding
+function checkTranscodingConfig () {
if (CONFIG.TRANSCODING.ENABLED) {
if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED === false && CONFIG.TRANSCODING.HLS.ENABLED === false) {
- return 'You need to enable at least WebTorrent transcoding or HLS transcoding.'
+ throw new Error('You need to enable at least WebTorrent transcoding or HLS transcoding.')
}
if (CONFIG.TRANSCODING.CONCURRENCY <= 0) {
- return 'Transcoding concurrency should be > 0'
+ throw new Error('Transcoding concurrency should be > 0')
}
}
if (CONFIG.IMPORT.VIDEOS.HTTP.ENABLED || CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED) {
if (CONFIG.IMPORT.VIDEOS.CONCURRENCY <= 0) {
- return 'Video import concurrency should be > 0'
+ throw new Error('Video import concurrency should be > 0')
}
}
+}
+
+function checkImportConfig () {
+ if (CONFIG.IMPORT.VIDEO_CHANNEL_SYNCHRONIZATION.ENABLED && !CONFIG.IMPORT.VIDEOS.HTTP) {
+ throw new Error('You need to enable HTTP import to allow synchronization')
+ }
+}
- // Broadcast message
+function checkBroadcastMessageConfig () {
if (CONFIG.BROADCAST_MESSAGE.ENABLED) {
const currentLevel = CONFIG.BROADCAST_MESSAGE.LEVEL
const available = [ 'info', 'warning', 'error' ]
if (available.includes(currentLevel) === false) {
- return 'Broadcast message level should be ' + available.join(' or ') + ' instead of ' + currentLevel
+ throw new Error('Broadcast message level should be ' + available.join(' or ') + ' instead of ' + currentLevel)
}
}
+}
- // Search index
+function checkSearchConfig () {
if (CONFIG.SEARCH.SEARCH_INDEX.ENABLED === true) {
if (CONFIG.SEARCH.REMOTE_URI.USERS === false) {
- return 'You cannot enable search index without enabling remote URI search for users.'
+ throw new Error('You cannot enable search index without enabling remote URI search for users.')
}
}
+}
- // Live
+function checkLiveConfig () {
if (CONFIG.LIVE.ENABLED === true) {
if (CONFIG.LIVE.ALLOW_REPLAY === true && CONFIG.TRANSCODING.ENABLED === false) {
- return 'Live allow replay cannot be enabled if transcoding is not enabled.'
+ throw new Error('Live allow replay cannot be enabled if transcoding is not enabled.')
}
- }
- return null
-}
+ if (CONFIG.LIVE.RTMP.ENABLED === false && CONFIG.LIVE.RTMPS.ENABLED === false) {
+ throw new Error('You must enable at least RTMP or RTMPS')
+ }
-// We get db by param to not import it in this file (import orders)
-async function clientsExist () {
- const totalClients = await OAuthClientModel.countTotal()
+ if (CONFIG.LIVE.RTMPS.ENABLED) {
+ if (!CONFIG.LIVE.RTMPS.KEY_FILE) {
+ throw new Error('You must specify a key file to enabled RTMPS')
+ }
- return totalClients !== 0
+ if (!CONFIG.LIVE.RTMPS.CERT_FILE) {
+ throw new Error('You must specify a cert file to enable RTMPS')
+ }
+ }
+ }
}
-// We get db by param to not import it in this file (import orders)
-async function usersExist () {
- const totalUsers = await UserModel.countTotal()
+function checkObjectStorageConfig () {
+ if (CONFIG.OBJECT_STORAGE.ENABLED === true) {
- return totalUsers !== 0
-}
+ if (!CONFIG.OBJECT_STORAGE.VIDEOS.BUCKET_NAME) {
+ throw new Error('videos_bucket should be set when object storage support is enabled.')
+ }
-// We get db by param to not import it in this file (import orders)
-async function applicationExist () {
- const totalApplication = await ApplicationModel.countTotal()
+ if (!CONFIG.OBJECT_STORAGE.STREAMING_PLAYLISTS.BUCKET_NAME) {
+ throw new Error('streaming_playlists_bucket should be set when object storage support is enabled.')
+ }
- return totalApplication !== 0
-}
+ if (
+ CONFIG.OBJECT_STORAGE.VIDEOS.BUCKET_NAME === CONFIG.OBJECT_STORAGE.STREAMING_PLAYLISTS.BUCKET_NAME &&
+ CONFIG.OBJECT_STORAGE.VIDEOS.PREFIX === CONFIG.OBJECT_STORAGE.STREAMING_PLAYLISTS.PREFIX
+ ) {
+ if (CONFIG.OBJECT_STORAGE.VIDEOS.PREFIX === '') {
+ throw new Error('Object storage bucket prefixes should be set when the same bucket is used for both types of video.')
+ }
-async function checkFFmpegVersion () {
- const version = await getFFmpegVersion()
- const { major, minor } = parseSemVersion(version)
+ throw new Error(
+ 'Object storage bucket prefixes should be set to different values when the same bucket is used for both types of video.'
+ )
+ }
- if (major < 4 || (major === 4 && minor < 1)) {
- logger.warn('Your ffmpeg version (%s) is outdated. PeerTube supports ffmpeg >= 4.1. Please upgrade.', version)
+ if (!CONFIG.OBJECT_STORAGE.UPLOAD_ACL.PUBLIC) {
+ throw new Error('object_storage.upload_acl.public must be set')
+ }
+
+ if (!CONFIG.OBJECT_STORAGE.UPLOAD_ACL.PRIVATE) {
+ throw new Error('object_storage.upload_acl.private must be set')
+ }
}
}
-// ---------------------------------------------------------------------------
-
-export {
- checkConfig,
- clientsExist,
- checkFFmpegVersion,
- usersExist,
- applicationExist,
- checkActivityPubUrls
+function checkVideoStudioConfig () {
+ if (CONFIG.VIDEO_STUDIO.ENABLED === true && CONFIG.TRANSCODING.ENABLED === false) {
+ throw new Error('Video studio cannot be enabled if transcoding is disabled')
+ }
}
projects / github / Chocobozzz / PeerTube.git / blobdiff