server/initializers/checker-before-init.ts

   1 import { IConfig } from 'config'
   2 import { promisify0 } from '@shared/core-utils'
   3 import { parseSemVersion } from '../helpers/core-utils'
   4 import { logger } from '../helpers/logger'
   5
   6 // Special behaviour for config because we can reload it
   7 const config: IConfig = require('config')
   8
   9 // ONLY USE CORE MODULES IN THIS FILE!
  10
  11 // Check the config files
  12 function checkMissedConfig () {
  13   const required = [ 'listen.port', 'listen.hostname',
  14     'webserver.https', 'webserver.hostname', 'webserver.port',
  15     'secrets.peertube',
  16     'trust_proxy',
  17     'oauth2.token_lifetime.access_token', 'oauth2.token_lifetime.refresh_token',
  18     'database.hostname', 'database.port', 'database.username', 'database.password', 'database.pool.max',
  19     'smtp.hostname', 'smtp.port', 'smtp.username', 'smtp.password', 'smtp.tls', 'smtp.from_address',
  20     'email.body.signature', 'email.subject.prefix',
  21     'storage.avatars', 'storage.videos', 'storage.logs', 'storage.previews', 'storage.thumbnails', 'storage.torrents', 'storage.cache',
  22     'storage.redundancy', 'storage.tmp', 'storage.streaming_playlists', 'storage.plugins', 'storage.well_known',
  23     'log.level', 'log.rotation.enabled', 'log.rotation.max_file_size', 'log.rotation.max_files', 'log.anonymize_ip',
  24     'log.log_ping_requests', 'log.log_tracker_unknown_infohash', 'log.prettify_sql', 'log.accept_client_log',
  25     'open_telemetry.metrics.enabled', 'open_telemetry.metrics.prometheus_exporter.hostname',
  26     'open_telemetry.metrics.prometheus_exporter.port', 'open_telemetry.tracing.enabled', 'open_telemetry.tracing.jaeger_exporter.endpoint',
  27     'open_telemetry.metrics.http_request_duration.enabled',
  28     'user.history.videos.enabled', 'user.video_quota', 'user.video_quota_daily',
  29     'video_channels.max_per_user',
  30     'csp.enabled', 'csp.report_only', 'csp.report_uri',
  31     'security.frameguard.enabled', 'security.powered_by_header.enabled',
  32     'cache.previews.size', 'cache.captions.size', 'cache.torrents.size', 'admin.email', 'contact_form.enabled',
  33     'signup.enabled', 'signup.limit', 'signup.requires_approval', 'signup.requires_email_verification', 'signup.minimum_age',
  34     'signup.filters.cidr.whitelist', 'signup.filters.cidr.blacklist',
  35     'redundancy.videos.strategies', 'redundancy.videos.check_interval',
  36     'transcoding.enabled', 'transcoding.threads', 'transcoding.allow_additional_extensions', 'transcoding.hls.enabled',
  37     'transcoding.profile', 'transcoding.concurrency',
  38     'transcoding.resolutions.0p', 'transcoding.resolutions.144p', 'transcoding.resolutions.240p', 'transcoding.resolutions.360p',
  39     'transcoding.resolutions.480p', 'transcoding.resolutions.720p', 'transcoding.resolutions.1080p', 'transcoding.resolutions.1440p',
  40     'transcoding.resolutions.2160p', 'transcoding.always_transcode_original_resolution', 'transcoding.remote_runners.enabled',
  41     'video_studio.enabled', 'video_studio.remote_runners.enabled',
  42     'remote_runners.stalled_jobs.vod', 'remote_runners.stalled_jobs.live',
  43     'import.videos.http.enabled', 'import.videos.torrent.enabled', 'import.videos.concurrency', 'import.videos.timeout',
  44     'import.video_channel_synchronization.enabled', 'import.video_channel_synchronization.max_per_user',
  45     'import.video_channel_synchronization.check_interval', 'import.video_channel_synchronization.videos_limit_per_synchronization',
  46     'import.video_channel_synchronization.full_sync_videos_limit',
  47     'auto_blacklist.videos.of_users.enabled', 'trending.videos.interval_days',
  48     'client.videos.miniature.display_author_avatar',
  49     'client.videos.miniature.prefer_author_display_name', 'client.menu.login.redirect_on_single_external_auth',
  50     'defaults.publish.download_enabled', 'defaults.publish.comments_enabled', 'defaults.publish.privacy', 'defaults.publish.licence',
  51     'instance.name', 'instance.short_description', 'instance.description', 'instance.terms', 'instance.default_client_route',
  52     'instance.is_nsfw', 'instance.default_nsfw_policy', 'instance.robots', 'instance.securitytxt',
  53     'services.twitter.username', 'services.twitter.whitelisted',
  54     'followers.instance.enabled', 'followers.instance.manual_approval',
  55     'tracker.enabled', 'tracker.private', 'tracker.reject_too_many_announces',
  56     'history.videos.max_age', 'views.videos.remote.max_age', 'views.videos.local_buffer_update_interval', 'views.videos.ip_view_expiration',
  57     'rates_limit.login.window', 'rates_limit.login.max', 'rates_limit.ask_send_email.window', 'rates_limit.ask_send_email.max',
  58     'static_files.private_files_require_auth',
  59     'object_storage.enabled', 'object_storage.endpoint', 'object_storage.region', 'object_storage.upload_acl.public',
  60     'object_storage.upload_acl.private', 'object_storage.proxy.proxify_private_files', 'object_storage.credentials.access_key_id',
  61     'object_storage.credentials.secret_access_key', 'object_storage.max_upload_part', 'object_storage.streaming_playlists.bucket_name',
  62     'object_storage.streaming_playlists.prefix', 'object_storage.streaming_playlists.base_url', 'object_storage.videos.bucket_name',
  63     'object_storage.videos.prefix', 'object_storage.videos.base_url',
  64     'theme.default',
  65     'feeds.videos.count', 'feeds.comments.count',
  66     'geo_ip.enabled', 'geo_ip.country.database_url',
  67     'remote_redundancy.videos.accept_from',
  68     'federation.videos.federate_unlisted', 'federation.videos.cleanup_remote_interactions',
  69     'peertube.check_latest_version.enabled', 'peertube.check_latest_version.url',
  70     'search.remote_uri.users', 'search.remote_uri.anonymous', 'search.search_index.enabled', 'search.search_index.url',
  71     'search.search_index.disable_local_search', 'search.search_index.is_default_search',
  72     'live.enabled', 'live.allow_replay', 'live.latency_setting.enabled', 'live.max_duration',
  73     'live.max_user_lives', 'live.max_instance_lives',
  74     'live.rtmp.enabled', 'live.rtmp.port', 'live.rtmp.hostname', 'live.rtmp.public_hostname',
  75     'live.rtmps.enabled', 'live.rtmps.port', 'live.rtmps.hostname', 'live.rtmps.public_hostname',
  76     'live.rtmps.key_file', 'live.rtmps.cert_file',
  77     'live.transcoding.enabled', 'live.transcoding.threads', 'live.transcoding.profile',
  78     'live.transcoding.resolutions.144p', 'live.transcoding.resolutions.240p', 'live.transcoding.resolutions.360p',
  79     'live.transcoding.resolutions.480p', 'live.transcoding.resolutions.720p', 'live.transcoding.resolutions.1080p',
  80     'live.transcoding.resolutions.1440p', 'live.transcoding.resolutions.2160p', 'live.transcoding.always_transcode_original_resolution',
  81     'live.transcoding.remote_runners.enabled'
  82   ]
  83
  84   const requiredAlternatives = [
  85     [ // set
  86       [ 'redis.hostname', 'redis.port' ], // alternative
  87       [ 'redis.socket' ],
  88       [ 'redis.sentinel.master_name', 'redis.sentinel.sentinels[0].hostname', 'redis.sentinel.sentinels[0].port' ]
  89     ]
  90   ]
  91   const miss: string[] = []
  92
  93   for (const key of required) {
  94     if (!config.has(key)) {
  95       miss.push(key)
  96     }
  97   }
  98
  99   const redundancyVideos = config.get<any>('redundancy.videos.strategies')
 100
 101   if (Array.isArray(redundancyVideos)) {
 102     for (const r of redundancyVideos) {
 103       if (!r.size) miss.push('redundancy.videos.strategies.size')
 104       if (!r.min_lifetime) miss.push('redundancy.videos.strategies.min_lifetime')
 105     }
 106   }
 107
 108   const missingAlternatives = requiredAlternatives.filter(
 109     set => !set.find(alternative => !alternative.find(key => !config.has(key)))
 110   )
 111
 112   missingAlternatives
 113     .forEach(set => set[0].forEach(key => miss.push(key)))
 114
 115   return miss
 116 }
 117
 118 // Check the available codecs
 119 // We get CONFIG by param to not import it in this file (import orders)
 120 async function checkFFmpeg (CONFIG: { TRANSCODING: { ENABLED: boolean } }) {
 121   if (CONFIG.TRANSCODING.ENABLED === false) return undefined
 122
 123   const Ffmpeg = require('fluent-ffmpeg')
 124   const getAvailableCodecsPromise = promisify0(Ffmpeg.getAvailableCodecs)
 125   const codecs = await getAvailableCodecsPromise()
 126   const canEncode = [ 'libx264' ]
 127
 128   for (const codec of canEncode) {
 129     if (codecs[codec] === undefined) {
 130       throw new Error('Unknown codec ' + codec + ' in FFmpeg.')
 131     }
 132
 133     if (codecs[codec].canEncode !== true) {
 134       throw new Error('Unavailable encode codec ' + codec + ' in FFmpeg')
 135     }
 136   }
 137 }
 138
 139 function checkNodeVersion () {
 140   const v = process.version
 141   const { major } = parseSemVersion(v)
 142
 143   logger.debug('Checking NodeJS version %s.', v)
 144
 145   if (major <= 12) {
 146     throw new Error('Your NodeJS version ' + v + ' is not supported. Please upgrade.')
 147   }
 148 }
 149
 150 // ---------------------------------------------------------------------------
 151
 152 export {
 153   checkFFmpeg,
 154   checkMissedConfig,
 155   checkNodeVersion
 156 }