checker-before-init.ts 9.2 KB

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