]>
Commit | Line | Data |
---|---|---|
1 | import { IConfig } from 'config' | |
2 | import { parseSemVersion, promisify0 } from '../helpers/core-utils' | |
3 | import { logger } from '../helpers/logger' | |
4 | ||
5 | // Special behaviour for config because we can reload it | |
6 | const config: IConfig = require('config') | |
7 | ||
8 | // ONLY USE CORE MODULES IN THIS FILE! | |
9 | ||
10 | // Check the config files | |
11 | function checkMissedConfig () { | |
12 | const required = [ 'listen.port', 'listen.hostname', | |
13 | 'webserver.https', 'webserver.hostname', 'webserver.port', | |
14 | 'secrets.peertube', | |
15 | 'trust_proxy', | |
16 | 'database.hostname', 'database.port', 'database.username', 'database.password', 'database.pool.max', | |
17 | 'smtp.hostname', 'smtp.port', 'smtp.username', 'smtp.password', 'smtp.tls', 'smtp.from_address', | |
18 | 'email.body.signature', 'email.subject.prefix', | |
19 | 'storage.avatars', 'storage.videos', 'storage.logs', 'storage.previews', 'storage.thumbnails', 'storage.torrents', 'storage.cache', | |
20 | 'storage.redundancy', 'storage.tmp', 'storage.streaming_playlists', 'storage.plugins', 'storage.well_known', | |
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', | |
25 | 'user.video_quota', 'user.video_quota_daily', | |
26 | 'video_channels.max_per_user', | |
27 | 'csp.enabled', 'csp.report_only', 'csp.report_uri', | |
28 | 'security.frameguard.enabled', | |
29 | 'cache.previews.size', 'cache.captions.size', 'cache.torrents.size', 'admin.email', 'contact_form.enabled', | |
30 | 'signup.enabled', 'signup.limit', '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.hls.enabled', | |
34 | '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', 'video_studio.enabled', | |
38 | 'import.videos.http.enabled', 'import.videos.torrent.enabled', 'import.videos.concurrency', 'import.videos.timeout', | |
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', | |
41 | 'import.video_channel_synchronization.full_sync_videos_limit', | |
42 | 'auto_blacklist.videos.of_users.enabled', 'trending.videos.interval_days', | |
43 | 'client.videos.miniature.display_author_avatar', | |
44 | 'client.videos.miniature.prefer_author_display_name', 'client.menu.login.redirect_on_single_external_auth', | |
45 | 'defaults.publish.download_enabled', 'defaults.publish.comments_enabled', 'defaults.publish.privacy', 'defaults.publish.licence', | |
46 | 'instance.name', 'instance.short_description', 'instance.description', 'instance.terms', 'instance.default_client_route', | |
47 | 'instance.is_nsfw', 'instance.default_nsfw_policy', 'instance.robots', 'instance.securitytxt', | |
48 | 'services.twitter.username', 'services.twitter.whitelisted', | |
49 | 'followers.instance.enabled', 'followers.instance.manual_approval', | |
50 | 'tracker.enabled', 'tracker.private', 'tracker.reject_too_many_announces', | |
51 | 'history.videos.max_age', 'views.videos.remote.max_age', 'views.videos.local_buffer_update_interval', 'views.videos.ip_view_expiration', | |
52 | 'rates_limit.login.window', 'rates_limit.login.max', 'rates_limit.ask_send_email.window', 'rates_limit.ask_send_email.max', | |
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', | |
59 | 'theme.default', | |
60 | 'feeds.videos.count', 'feeds.comments.count', | |
61 | 'geo_ip.enabled', 'geo_ip.country.database_url', | |
62 | 'remote_redundancy.videos.accept_from', | |
63 | 'federation.videos.federate_unlisted', 'federation.videos.cleanup_remote_interactions', | |
64 | 'peertube.check_latest_version.enabled', 'peertube.check_latest_version.url', | |
65 | 'search.remote_uri.users', 'search.remote_uri.anonymous', 'search.search_index.enabled', 'search.search_index.url', | |
66 | 'search.search_index.disable_local_search', 'search.search_index.is_default_search', | |
67 | 'live.enabled', 'live.allow_replay', 'live.latency_setting.enabled', 'live.max_duration', | |
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', | |
72 | 'live.transcoding.enabled', 'live.transcoding.threads', 'live.transcoding.profile', | |
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', | |
75 | 'live.transcoding.resolutions.1440p', 'live.transcoding.resolutions.2160p', 'live.transcoding.always_transcode_original_resolution' | |
76 | ] | |
77 | ||
78 | const requiredAlternatives = [ | |
79 | [ // set | |
80 | [ 'redis.hostname', 'redis.port' ], // alternative | |
81 | [ 'redis.socket' ] | |
82 | ] | |
83 | ] | |
84 | const miss: string[] = [] | |
85 | ||
86 | for (const key of required) { | |
87 | if (!config.has(key)) { | |
88 | miss.push(key) | |
89 | } | |
90 | } | |
91 | ||
92 | const redundancyVideos = config.get<any>('redundancy.videos.strategies') | |
93 | ||
94 | if (Array.isArray(redundancyVideos)) { | |
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 | ||
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 | ||
108 | return miss | |
109 | } | |
110 | ||
111 | // Check the available codecs | |
112 | // We get CONFIG by param to not import it in this file (import orders) | |
113 | async function checkFFmpeg (CONFIG: { TRANSCODING: { ENABLED: boolean } }) { | |
114 | if (CONFIG.TRANSCODING.ENABLED === false) return undefined | |
115 | ||
116 | const Ffmpeg = require('fluent-ffmpeg') | |
117 | const getAvailableCodecsPromise = promisify0(Ffmpeg.getAvailableCodecs) | |
118 | const codecs = await getAvailableCodecsPromise() | |
119 | const canEncode = [ 'libx264' ] | |
120 | ||
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 | } | |
130 | } | |
131 | ||
132 | function checkNodeVersion () { | |
133 | const v = process.version | |
134 | const { major } = parseSemVersion(v) | |
135 | ||
136 | logger.debug('Checking NodeJS version %s.', v) | |
137 | ||
138 | if (major <= 12) { | |
139 | throw new Error('Your NodeJS version ' + v + ' is not supported. Please upgrade.') | |
140 | } | |
141 | } | |
142 | ||
143 | // --------------------------------------------------------------------------- | |
144 | ||
145 | export { | |
146 | checkFFmpeg, | |
147 | checkMissedConfig, | |
148 | checkNodeVersion | |
149 | } |