server/initializers/checker-after-init.ts

   1 import * as config from 'config'
   2 import { isProdInstance, isTestInstance } from '../helpers/core-utils'
   3 import { UserModel } from '../models/account/user'
   4 import { getServerActor, ApplicationModel } from '../models/application/application'
   5 import { OAuthClientModel } from '../models/oauth/oauth-client'
   6 import { URL } from 'url'
   7 import { CONFIG, isEmailEnabled } from './config'
   8 import { logger } from '../helpers/logger'
   9 import { RecentlyAddedStrategy } from '../../shared/models/redundancy'
  10 import { isArray } from '../helpers/custom-validators/misc'
  11 import { uniq } from 'lodash'
  12 import { WEBSERVER } from './constants'
  13 import { VideoRedundancyConfigFilter } from '@shared/models/redundancy/video-redundancy-config-filter.type'
  14
  15 async function checkActivityPubUrls () {
  16   const actor = await getServerActor()
  17
  18   const parsed = new URL(actor.url)
  19   if (WEBSERVER.HOST !== parsed.host) {
  20     const NODE_ENV = config.util.getEnv('NODE_ENV')
  21     const NODE_CONFIG_DIR = config.util.getEnv('NODE_CONFIG_DIR')
  22
  23     logger.warn(
  24       'It seems PeerTube was started (and created some data) with another domain name. ' +
  25       'This means you will not be able to federate! ' +
  26       'Please use %s %s npm run update-host to fix this.',
  27       NODE_CONFIG_DIR ? `NODE_CONFIG_DIR=${NODE_CONFIG_DIR}` : '',
  28       NODE_ENV ? `NODE_ENV=${NODE_ENV}` : ''
  29     )
  30   }
  31 }
  32
  33 // Some checks on configuration files
  34 // Return an error message, or null if everything is okay
  35 function checkConfig () {
  36
  37   // Moved configuration keys
  38   if (config.has('services.csp-logger')) {
  39     logger.warn('services.csp-logger configuration has been renamed to csp.report_uri. Please update your configuration file.')
  40   }
  41
  42   // Email verification
  43   if (!isEmailEnabled()) {
  44     if (CONFIG.SIGNUP.ENABLED && CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
  45       return 'Emailer is disabled but you require signup email verification.'
  46     }
  47
  48     if (CONFIG.CONTACT_FORM.ENABLED) {
  49       logger.warn('Emailer is disabled so the contact form will not work.')
  50     }
  51   }
  52
  53   // NSFW policy
  54   const defaultNSFWPolicy = CONFIG.INSTANCE.DEFAULT_NSFW_POLICY
  55   {
  56     const available = [ 'do_not_list', 'blur', 'display' ]
  57     if (available.includes(defaultNSFWPolicy) === false) {
  58       return 'NSFW policy setting should be ' + available.join(' or ') + ' instead of ' + defaultNSFWPolicy
  59     }
  60   }
  61
  62   // Redundancies
  63   const redundancyVideos = CONFIG.REDUNDANCY.VIDEOS.STRATEGIES
  64   if (isArray(redundancyVideos)) {
  65     const available = [ 'most-views', 'trending', 'recently-added' ]
  66     for (const r of redundancyVideos) {
  67       if (available.includes(r.strategy) === false) {
  68         return 'Videos redundancy should have ' + available.join(' or ') + ' strategy instead of ' + r.strategy
  69       }
  70
  71       // Lifetime should not be < 10 hours
  72       if (!isTestInstance() && r.minLifetime < 1000 * 3600 * 10) {
  73         return 'Video redundancy minimum lifetime should be >= 10 hours for strategy ' + r.strategy
  74       }
  75     }
  76
  77     const filtered = uniq(redundancyVideos.map(r => r.strategy))
  78     if (filtered.length !== redundancyVideos.length) {
  79       return 'Redundancy video entries should have unique strategies'
  80     }
  81
  82     const recentlyAddedStrategy = redundancyVideos.find(r => r.strategy === 'recently-added') as RecentlyAddedStrategy
  83     if (recentlyAddedStrategy && isNaN(recentlyAddedStrategy.minViews)) {
  84       return 'Min views in recently added strategy is not a number'
  85     }
  86   } else {
  87     return 'Videos redundancy should be an array (you must uncomment lines containing - too)'
  88   }
  89
  90   // Remote redundancies
  91   const acceptFrom = CONFIG.REMOTE_REDUNDANCY.VIDEOS.ACCEPT_FROM
  92   const acceptFromValues = new Set<VideoRedundancyConfigFilter>([ 'nobody', 'anybody', 'followings' ])
  93   if (acceptFromValues.has(acceptFrom) === false) {
  94     return 'remote_redundancy.videos.accept_from has an incorrect value'
  95   }
  96
  97   // Check storage directory locations
  98   if (isProdInstance()) {
  99     const configStorage = config.get('storage')
 100     for (const key of Object.keys(configStorage)) {
 101       if (configStorage[key].startsWith('storage/')) {
 102         logger.warn(
 103           'Directory of %s should not be in the production directory of PeerTube. Please check your production configuration file.',
 104           key
 105         )
 106       }
 107     }
 108   }
 109
 110   if (CONFIG.STORAGE.VIDEOS_DIR === CONFIG.STORAGE.REDUNDANCY_DIR) {
 111     logger.warn('Redundancy directory should be different than the videos folder.')
 112   }
 113
 114   // Transcoding
 115   if (CONFIG.TRANSCODING.ENABLED) {
 116     if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED === false && CONFIG.TRANSCODING.HLS.ENABLED === false) {
 117       return 'You need to enable at least WebTorrent transcoding or HLS transcoding.'
 118     }
 119   }
 120
 121   // Broadcast message
 122   if (CONFIG.BROADCAST_MESSAGE.ENABLED) {
 123     const currentLevel = CONFIG.BROADCAST_MESSAGE.LEVEL
 124     const available = [ 'info', 'warning', 'error' ]
 125
 126     if (available.includes(currentLevel) === false) {
 127       return 'Broadcast message level should be ' + available.join(' or ') + ' instead of ' + currentLevel
 128     }
 129   }
 130
 131   // Search index
 132   if (CONFIG.SEARCH.SEARCH_INDEX.ENABLED === true) {
 133     if (CONFIG.SEARCH.REMOTE_URI.USERS === false) {
 134       return 'You cannot enable search index without enabling remote URI search for users.'
 135     }
 136   }
 137
 138   // Live
 139   if (CONFIG.LIVE.ENABLED === true) {
 140     if (CONFIG.LIVE.ALLOW_REPLAY === true && CONFIG.TRANSCODING.ENABLED === false) {
 141       return 'Live allow replay cannot be enabled if transcoding is not enabled.'
 142     }
 143   }
 144
 145   return null
 146 }
 147
 148 // We get db by param to not import it in this file (import orders)
 149 async function clientsExist () {
 150   const totalClients = await OAuthClientModel.countTotal()
 151
 152   return totalClients !== 0
 153 }
 154
 155 // We get db by param to not import it in this file (import orders)
 156 async function usersExist () {
 157   const totalUsers = await UserModel.countTotal()
 158
 159   return totalUsers !== 0
 160 }
 161
 162 // We get db by param to not import it in this file (import orders)
 163 async function applicationExist () {
 164   const totalApplication = await ApplicationModel.countTotal()
 165
 166   return totalApplication !== 0
 167 }
 168
 169 // ---------------------------------------------------------------------------
 170
 171 export {
 172   checkConfig,
 173   clientsExist,
 174   usersExist,
 175   applicationExist,
 176   checkActivityPubUrls
 177 }