server/initializers/checker-after-init.ts

   1 import config from 'config'
   2 import { URL } from 'url'
   3 import { getFFmpegVersion } from '@server/helpers/ffmpeg'
   4 import { uniqify } from '@shared/core-utils'
   5 import { VideoRedundancyConfigFilter } from '@shared/models/redundancy/video-redundancy-config-filter.type'
   6 import { RecentlyAddedStrategy } from '../../shared/models/redundancy'
   7 import { isProdInstance, parseSemVersion } from '../helpers/core-utils'
   8 import { isArray } from '../helpers/custom-validators/misc'
   9 import { logger } from '../helpers/logger'
  10 import { ApplicationModel, getServerActor } from '../models/application/application'
  11 import { OAuthClientModel } from '../models/oauth/oauth-client'
  12 import { UserModel } from '../models/user/user'
  13 import { CONFIG, isEmailEnabled } from './config'
  14 import { WEBSERVER } from './constants'
  15
  16 async function checkActivityPubUrls () {
  17   const actor = await getServerActor()
  18
  19   const parsed = new URL(actor.url)
  20   if (WEBSERVER.HOST !== parsed.host) {
  21     const NODE_ENV = config.util.getEnv('NODE_ENV')
  22     const NODE_CONFIG_DIR = config.util.getEnv('NODE_CONFIG_DIR')
  23
  24     logger.warn(
  25       'It seems PeerTube was started (and created some data) with another domain name. ' +
  26       'This means you will not be able to federate! ' +
  27       'Please use %s %s npm run update-host to fix this.',
  28       NODE_CONFIG_DIR ? `NODE_CONFIG_DIR=${NODE_CONFIG_DIR}` : '',
  29       NODE_ENV ? `NODE_ENV=${NODE_ENV}` : ''
  30     )
  31   }
  32 }
  33
  34 // Some checks on configuration files or throw if there is an error
  35 function checkConfig () {
  36
  37   const configFiles = config.util.getConfigSources().map(s => s.name).join(' -> ')
  38   logger.info('Using following configuration file hierarchy: %s.', configFiles)
  39
  40   // Moved configuration keys
  41   if (config.has('services.csp-logger')) {
  42     logger.warn('services.csp-logger configuration has been renamed to csp.report_uri. Please update your configuration file.')
  43   }
  44
  45   checkSecretsConfig()
  46   checkEmailConfig()
  47   checkNSFWPolicyConfig()
  48   checkLocalRedundancyConfig()
  49   checkRemoteRedundancyConfig()
  50   checkStorageConfig()
  51   checkTranscodingConfig()
  52   checkImportConfig()
  53   checkBroadcastMessageConfig()
  54   checkSearchConfig()
  55   checkLiveConfig()
  56   checkObjectStorageConfig()
  57   checkVideoStudioConfig()
  58 }
  59
  60 // We get db by param to not import it in this file (import orders)
  61 async function clientsExist () {
  62   const totalClients = await OAuthClientModel.countTotal()
  63
  64   return totalClients !== 0
  65 }
  66
  67 // We get db by param to not import it in this file (import orders)
  68 async function usersExist () {
  69   const totalUsers = await UserModel.countTotal()
  70
  71   return totalUsers !== 0
  72 }
  73
  74 // We get db by param to not import it in this file (import orders)
  75 async function applicationExist () {
  76   const totalApplication = await ApplicationModel.countTotal()
  77
  78   return totalApplication !== 0
  79 }
  80
  81 async function checkFFmpegVersion () {
  82   const version = await getFFmpegVersion()
  83   const { major, minor, patch } = parseSemVersion(version)
  84
  85   if (major < 4 || (major === 4 && minor < 1)) {
  86     logger.warn('Your ffmpeg version (%s) is outdated. PeerTube supports ffmpeg >= 4.1. Please upgrade ffmpeg.', version)
  87   }
  88
  89   if (major === 4 && minor === 4 && patch === 0) {
  90     logger.warn('There is a bug in ffmpeg 4.4.0 with HLS videos. Please upgrade ffmpeg.')
  91   }
  92 }
  93
  94 // ---------------------------------------------------------------------------
  95
  96 export {
  97   checkConfig,
  98   clientsExist,
  99   checkFFmpegVersion,
 100   usersExist,
 101   applicationExist,
 102   checkActivityPubUrls
 103 }
 104
 105 // ---------------------------------------------------------------------------
 106
 107 function checkSecretsConfig () {
 108   if (!CONFIG.SECRETS.PEERTUBE) {
 109     throw new Error('secrets.peertube is missing in config. Generate one using `openssl rand -hex 32`')
 110   }
 111 }
 112
 113 function checkEmailConfig () {
 114   if (!isEmailEnabled()) {
 115     if (CONFIG.SIGNUP.ENABLED && CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
 116       throw new Error('Emailer is disabled but you require signup email verification.')
 117     }
 118
 119     if (CONFIG.CONTACT_FORM.ENABLED) {
 120       logger.warn('Emailer is disabled so the contact form will not work.')
 121     }
 122   }
 123 }
 124
 125 function checkNSFWPolicyConfig () {
 126   const defaultNSFWPolicy = CONFIG.INSTANCE.DEFAULT_NSFW_POLICY
 127
 128   const available = [ 'do_not_list', 'blur', 'display' ]
 129   if (available.includes(defaultNSFWPolicy) === false) {
 130     throw new Error('NSFW policy setting should be ' + available.join(' or ') + ' instead of ' + defaultNSFWPolicy)
 131   }
 132 }
 133
 134 function checkLocalRedundancyConfig () {
 135   const redundancyVideos = CONFIG.REDUNDANCY.VIDEOS.STRATEGIES
 136
 137   if (isArray(redundancyVideos)) {
 138     const available = [ 'most-views', 'trending', 'recently-added' ]
 139
 140     for (const r of redundancyVideos) {
 141       if (available.includes(r.strategy) === false) {
 142         throw new Error('Videos redundancy should have ' + available.join(' or ') + ' strategy instead of ' + r.strategy)
 143       }
 144
 145       // Lifetime should not be < 10 hours
 146       if (isProdInstance() && r.minLifetime < 1000 * 3600 * 10) {
 147         throw new Error('Video redundancy minimum lifetime should be >= 10 hours for strategy ' + r.strategy)
 148       }
 149     }
 150
 151     const filtered = uniqify(redundancyVideos.map(r => r.strategy))
 152     if (filtered.length !== redundancyVideos.length) {
 153       throw new Error('Redundancy video entries should have unique strategies')
 154     }
 155
 156     const recentlyAddedStrategy = redundancyVideos.find(r => r.strategy === 'recently-added') as RecentlyAddedStrategy
 157     if (recentlyAddedStrategy && isNaN(recentlyAddedStrategy.minViews)) {
 158       throw new Error('Min views in recently added strategy is not a number')
 159     }
 160   } else {
 161     throw new Error('Videos redundancy should be an array (you must uncomment lines containing - too)')
 162   }
 163 }
 164
 165 function checkRemoteRedundancyConfig () {
 166   const acceptFrom = CONFIG.REMOTE_REDUNDANCY.VIDEOS.ACCEPT_FROM
 167   const acceptFromValues = new Set<VideoRedundancyConfigFilter>([ 'nobody', 'anybody', 'followings' ])
 168
 169   if (acceptFromValues.has(acceptFrom) === false) {
 170     throw new Error('remote_redundancy.videos.accept_from has an incorrect value')
 171   }
 172 }
 173
 174 function checkStorageConfig () {
 175   // Check storage directory locations
 176   if (isProdInstance()) {
 177     const configStorage = config.get('storage')
 178     for (const key of Object.keys(configStorage)) {
 179       if (configStorage[key].startsWith('storage/')) {
 180         logger.warn(
 181           'Directory of %s should not be in the production directory of PeerTube. Please check your production configuration file.',
 182           key
 183         )
 184       }
 185     }
 186   }
 187
 188   if (CONFIG.STORAGE.VIDEOS_DIR === CONFIG.STORAGE.REDUNDANCY_DIR) {
 189     logger.warn('Redundancy directory should be different than the videos folder.')
 190   }
 191 }
 192
 193 function checkTranscodingConfig () {
 194   if (CONFIG.TRANSCODING.ENABLED) {
 195     if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED === false && CONFIG.TRANSCODING.HLS.ENABLED === false) {
 196       throw new Error('You need to enable at least WebTorrent transcoding or HLS transcoding.')
 197     }
 198
 199     if (CONFIG.TRANSCODING.CONCURRENCY <= 0) {
 200       throw new Error('Transcoding concurrency should be > 0')
 201     }
 202   }
 203
 204   if (CONFIG.IMPORT.VIDEOS.HTTP.ENABLED || CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED) {
 205     if (CONFIG.IMPORT.VIDEOS.CONCURRENCY <= 0) {
 206       throw new Error('Video import concurrency should be > 0')
 207     }
 208   }
 209 }
 210
 211 function checkImportConfig () {
 212   if (CONFIG.IMPORT.VIDEO_CHANNEL_SYNCHRONIZATION.ENABLED && !CONFIG.IMPORT.VIDEOS.HTTP) {
 213     throw new Error('You need to enable HTTP import to allow synchronization')
 214   }
 215 }
 216
 217 function checkBroadcastMessageConfig () {
 218   if (CONFIG.BROADCAST_MESSAGE.ENABLED) {
 219     const currentLevel = CONFIG.BROADCAST_MESSAGE.LEVEL
 220     const available = [ 'info', 'warning', 'error' ]
 221
 222     if (available.includes(currentLevel) === false) {
 223       throw new Error('Broadcast message level should be ' + available.join(' or ') + ' instead of ' + currentLevel)
 224     }
 225   }
 226 }
 227
 228 function checkSearchConfig () {
 229   if (CONFIG.SEARCH.SEARCH_INDEX.ENABLED === true) {
 230     if (CONFIG.SEARCH.REMOTE_URI.USERS === false) {
 231       throw new Error('You cannot enable search index without enabling remote URI search for users.')
 232     }
 233   }
 234 }
 235
 236 function checkLiveConfig () {
 237   if (CONFIG.LIVE.ENABLED === true) {
 238     if (CONFIG.LIVE.ALLOW_REPLAY === true && CONFIG.TRANSCODING.ENABLED === false) {
 239       throw new Error('Live allow replay cannot be enabled if transcoding is not enabled.')
 240     }
 241
 242     if (CONFIG.LIVE.RTMP.ENABLED === false && CONFIG.LIVE.RTMPS.ENABLED === false) {
 243       throw new Error('You must enable at least RTMP or RTMPS')
 244     }
 245
 246     if (CONFIG.LIVE.RTMPS.ENABLED) {
 247       if (!CONFIG.LIVE.RTMPS.KEY_FILE) {
 248         throw new Error('You must specify a key file to enabled RTMPS')
 249       }
 250
 251       if (!CONFIG.LIVE.RTMPS.CERT_FILE) {
 252         throw new Error('You must specify a cert file to enable RTMPS')
 253       }
 254     }
 255   }
 256 }
 257
 258 function checkObjectStorageConfig () {
 259   if (CONFIG.OBJECT_STORAGE.ENABLED === true) {
 260
 261     if (!CONFIG.OBJECT_STORAGE.VIDEOS.BUCKET_NAME) {
 262       throw new Error('videos_bucket should be set when object storage support is enabled.')
 263     }
 264
 265     if (!CONFIG.OBJECT_STORAGE.STREAMING_PLAYLISTS.BUCKET_NAME) {
 266       throw new Error('streaming_playlists_bucket should be set when object storage support is enabled.')
 267     }
 268
 269     if (
 270       CONFIG.OBJECT_STORAGE.VIDEOS.BUCKET_NAME === CONFIG.OBJECT_STORAGE.STREAMING_PLAYLISTS.BUCKET_NAME &&
 271       CONFIG.OBJECT_STORAGE.VIDEOS.PREFIX === CONFIG.OBJECT_STORAGE.STREAMING_PLAYLISTS.PREFIX
 272     ) {
 273       if (CONFIG.OBJECT_STORAGE.VIDEOS.PREFIX === '') {
 274         throw new Error('Object storage bucket prefixes should be set when the same bucket is used for both types of video.')
 275       }
 276
 277       throw new Error(
 278         'Object storage bucket prefixes should be set to different values when the same bucket is used for both types of video.'
 279       )
 280     }
 281   }
 282 }
 283
 284 function checkVideoStudioConfig () {
 285   if (CONFIG.VIDEO_STUDIO.ENABLED === true && CONFIG.TRANSCODING.ENABLED === false) {
 286     throw new Error('Video studio cannot be enabled if transcoding is disabled')
 287   }
 288 }