]>
Commit | Line | Data |
---|---|---|
41fb13c3 | 1 | import { IConfig } from 'config' |
ae71acca | 2 | import { parseSemVersion, promisify0 } from '../helpers/core-utils' |
51c35447 | 3 | import { logger } from '../helpers/logger' |
9f10b292 | 4 | |
41fb13c3 C |
5 | // Special behaviour for config because we can reload it |
6 | const config: IConfig = require('config') | |
7 | ||
e5565833 | 8 | // ONLY USE CORE MODULES IN THIS FILE! |
b65c27aa C |
9 | |
10 | // Check the config files | |
11 | function checkMissedConfig () { | |
cff8b272 | 12 | const required = [ 'listen.port', 'listen.hostname', |
3737bbaf | 13 | 'webserver.https', 'webserver.hostname', 'webserver.port', |
a3e5f804 | 14 | 'secrets.peertube', |
490b595a | 15 | 'trust_proxy', |
3a735f7d | 16 | 'database.hostname', 'database.port', 'database.username', 'database.password', 'database.pool.max', |
a465bf5f | 17 | 'smtp.hostname', 'smtp.port', 'smtp.username', 'smtp.password', 'smtp.tls', 'smtp.from_address', |
916937d7 | 18 | 'email.body.signature', 'email.subject.prefix', |
a465bf5f | 19 | 'storage.avatars', 'storage.videos', 'storage.logs', 'storage.previews', 'storage.thumbnails', 'storage.torrents', 'storage.cache', |
6c5f0d3a | 20 | 'storage.redundancy', 'storage.tmp', 'storage.streaming_playlists', 'storage.plugins', 'storage.well_known', |
31a9ed96 C |
21 | 'log.level', 'log.rotation.enabled', 'log.rotation.max_file_size', 'log.rotation.max_files', 'log.anonymize_ip', |
22 | 'log.log_ping_requests', 'log.log_tracker_unknown_infohash', 'log.prettify_sql', 'log.accept_client_log', | |
23 | 'open_telemetry.metrics.enabled', 'open_telemetry.metrics.prometheus_exporter.hostname', | |
24 | 'open_telemetry.metrics.prometheus_exporter.port', 'open_telemetry.tracing.enabled', 'open_telemetry.tracing.jaeger_exporter.endpoint', | |
bee0abff | 25 | 'user.video_quota', 'user.video_quota_daily', |
754b6f5f | 26 | 'video_channels.max_per_user', |
539d3f4f | 27 | 'csp.enabled', 'csp.report_only', 'csp.report_uri', |
8155db66 | 28 | 'security.frameguard.enabled', |
90a8bd30 | 29 | 'cache.previews.size', 'cache.captions.size', 'cache.torrents.size', 'admin.email', 'contact_form.enabled', |
1f256e7d | 30 | 'signup.enabled', 'signup.limit', 'signup.requires_email_verification', 'signup.minimum_age', |
d9eaee39 | 31 | 'signup.filters.cidr.whitelist', 'signup.filters.cidr.blacklist', |
f9f899b9 | 32 | 'redundancy.videos.strategies', 'redundancy.videos.check_interval', |
5d9e4eaa | 33 | 'transcoding.enabled', 'transcoding.threads', 'transcoding.allow_additional_extensions', 'transcoding.hls.enabled', |
9129b769 | 34 | 'transcoding.profile', 'transcoding.concurrency', |
8dd754c7 FC |
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', | |
84cae54e | 37 | 'transcoding.resolutions.2160p', 'transcoding.always_transcode_original_resolution', 'video_studio.enabled', |
3eba7ab8 | 38 | 'import.videos.http.enabled', 'import.videos.torrent.enabled', 'import.videos.concurrency', 'import.videos.timeout', |
2a491182 F |
39 | 'import.video_channel_synchronization.enabled', 'import.video_channel_synchronization.max_per_user', |
40 | 'import.video_channel_synchronization.check_interval', 'import.video_channel_synchronization.videos_limit_per_synchronization', | |
4efa5535 | 41 | 'import.video_channel_synchronization.full_sync_videos_limit', |
3eba7ab8 | 42 | 'auto_blacklist.videos.of_users.enabled', 'trending.videos.interval_days', |
2c102aac | 43 | 'client.videos.miniature.display_author_avatar', |
0bc53e20 | 44 | 'client.videos.miniature.prefer_author_display_name', 'client.menu.login.redirect_on_single_external_auth', |
3cf68b86 | 45 | 'defaults.publish.download_enabled', 'defaults.publish.comments_enabled', 'defaults.publish.privacy', 'defaults.publish.licence', |
0883b324 | 46 | 'instance.name', 'instance.short_description', 'instance.description', 'instance.terms', 'instance.default_client_route', |
f8802489 | 47 | 'instance.is_nsfw', 'instance.default_nsfw_policy', 'instance.robots', 'instance.securitytxt', |
5b9c965d | 48 | 'services.twitter.username', 'services.twitter.whitelisted', |
31b6ddf8 | 49 | 'followers.instance.enabled', 'followers.instance.manual_approval', |
cda03765 | 50 | 'tracker.enabled', 'tracker.private', 'tracker.reject_too_many_announces', |
51353d9a | 51 | 'history.videos.max_age', 'views.videos.remote.max_age', 'views.videos.local_buffer_update_interval', 'views.videos.ip_view_expiration', |
7cd4d2ba | 52 | 'rates_limit.login.window', 'rates_limit.login.max', 'rates_limit.ask_send_email.window', 'rates_limit.ask_send_email.max', |
1b0a04de C |
53 | 'static_files.private_files_require_auth', |
54 | 'object_storage.enabled', 'object_storage.endpoint', 'object_storage.region', 'object_storage.upload_acl.public', | |
55 | 'object_storage.upload_acl.private', 'object_storage.proxy.proxify_private_files', 'object_storage.credentials.access_key_id', | |
56 | 'object_storage.credentials.secret_access_key', 'object_storage.max_upload_part', 'object_storage.streaming_playlists.bucket_name', | |
57 | 'object_storage.streaming_playlists.prefix', 'object_storage.streaming_playlists.base_url', 'object_storage.videos.bucket_name', | |
58 | 'object_storage.videos.prefix', 'object_storage.videos.base_url', | |
8c9e7875 | 59 | 'theme.default', |
600befbd | 60 | 'feeds.videos.count', 'feeds.comments.count', |
b2111066 | 61 | 'geo_ip.enabled', 'geo_ip.country.database_url', |
3092e9bb | 62 | 'remote_redundancy.videos.accept_from', |
74d249bc | 63 | 'federation.videos.federate_unlisted', 'federation.videos.cleanup_remote_interactions', |
32a18cbf | 64 | 'peertube.check_latest_version.enabled', 'peertube.check_latest_version.url', |
5fb2e288 | 65 | 'search.remote_uri.users', 'search.remote_uri.anonymous', 'search.search_index.enabled', 'search.search_index.url', |
fb719404 | 66 | 'search.search_index.disable_local_search', 'search.search_index.is_default_search', |
f443a746 | 67 | 'live.enabled', 'live.allow_replay', 'live.latency_setting.enabled', 'live.max_duration', |
d05af385 C |
68 | 'live.max_user_lives', 'live.max_instance_lives', |
69 | 'live.rtmp.enabled', 'live.rtmp.port', 'live.rtmp.hostname', 'live.rtmp.public_hostname', | |
70 | 'live.rtmps.enabled', 'live.rtmps.port', 'live.rtmps.hostname', 'live.rtmps.public_hostname', | |
71 | 'live.rtmps.key_file', 'live.rtmps.cert_file', | |
80ac2e55 | 72 | 'live.transcoding.enabled', 'live.transcoding.threads', 'live.transcoding.profile', |
8dd754c7 FC |
73 | 'live.transcoding.resolutions.144p', 'live.transcoding.resolutions.240p', 'live.transcoding.resolutions.360p', |
74 | 'live.transcoding.resolutions.480p', 'live.transcoding.resolutions.720p', 'live.transcoding.resolutions.1080p', | |
84cae54e | 75 | 'live.transcoding.resolutions.1440p', 'live.transcoding.resolutions.2160p', 'live.transcoding.always_transcode_original_resolution' |
56835348 | 76 | ] |
fb719404 | 77 | |
19f7b248 RK |
78 | const requiredAlternatives = [ |
79 | [ // set | |
a1587156 C |
80 | [ 'redis.hostname', 'redis.port' ], // alternative |
81 | [ 'redis.socket' ] | |
19f7b248 RK |
82 | ] |
83 | ] | |
69818c93 | 84 | const miss: string[] = [] |
9f10b292 | 85 | |
f0f5567b | 86 | for (const key of required) { |
9f10b292 C |
87 | if (!config.has(key)) { |
88 | miss.push(key) | |
8c308c2b | 89 | } |
8c308c2b C |
90 | } |
91 | ||
e5565833 | 92 | const redundancyVideos = config.get<any>('redundancy.videos.strategies') |
d85798c4 C |
93 | |
94 | if (Array.isArray(redundancyVideos)) { | |
e5565833 C |
95 | for (const r of redundancyVideos) { |
96 | if (!r.size) miss.push('redundancy.videos.strategies.size') | |
97 | if (!r.min_lifetime) miss.push('redundancy.videos.strategies.min_lifetime') | |
98 | } | |
99 | } | |
100 | ||
19f7b248 RK |
101 | const missingAlternatives = requiredAlternatives.filter( |
102 | set => !set.find(alternative => !alternative.find(key => !config.has(key))) | |
103 | ) | |
104 | ||
105 | missingAlternatives | |
106 | .forEach(set => set[0].forEach(key => miss.push(key))) | |
107 | ||
9f10b292 C |
108 | return miss |
109 | } | |
110 | ||
e5b88539 | 111 | // Check the available codecs |
3482688c | 112 | // We get CONFIG by param to not import it in this file (import orders) |
f5028693 | 113 | async function checkFFmpeg (CONFIG: { TRANSCODING: { ENABLED: boolean } }) { |
959dbbd7 C |
114 | if (CONFIG.TRANSCODING.ENABLED === false) return undefined |
115 | ||
e5b88539 | 116 | const Ffmpeg = require('fluent-ffmpeg') |
6fcd19ba | 117 | const getAvailableCodecsPromise = promisify0(Ffmpeg.getAvailableCodecs) |
f5028693 | 118 | const codecs = await getAvailableCodecsPromise() |
4176e227 RK |
119 | const canEncode = [ 'libx264' ] |
120 | ||
f5028693 C |
121 | for (const codec of canEncode) { |
122 | if (codecs[codec] === undefined) { | |
123 | throw new Error('Unknown codec ' + codec + ' in FFmpeg.') | |
124 | } | |
125 | ||
126 | if (codecs[codec].canEncode !== true) { | |
127 | throw new Error('Unavailable encode codec ' + codec + ' in FFmpeg') | |
128 | } | |
129 | } | |
e5b88539 C |
130 | } |
131 | ||
51c35447 C |
132 | function checkNodeVersion () { |
133 | const v = process.version | |
ae71acca | 134 | const { major } = parseSemVersion(v) |
51c35447 C |
135 | |
136 | logger.debug('Checking NodeJS version %s.', v) | |
137 | ||
4ff75a3b | 138 | if (major <= 12) { |
90fbb784 | 139 | throw new Error('Your NodeJS version ' + v + ' is not supported. Please upgrade.') |
4ff75a3b | 140 | } |
51c35447 C |
141 | } |
142 | ||
9f10b292 | 143 | // --------------------------------------------------------------------------- |
c45f7f84 | 144 | |
65fcc311 | 145 | export { |
65fcc311 | 146 | checkFFmpeg, |
51c35447 C |
147 | checkMissedConfig, |
148 | checkNodeVersion | |
65fcc311 | 149 | } |