1 // ----------- Node modules -----------
2 import { registerOpentelemetryTracing } from './server/lib/opentelemetry/tracing'
3 registerOpentelemetryTracing()
5 import express from 'express'
6 import morgan, { token } from 'morgan'
7 import cors from 'cors'
8 import cookieParser from 'cookie-parser'
9 import { frameguard } from 'helmet'
10 import { parse } from 'useragent'
11 import anonymize from 'ip-anonymize'
12 import { program as cli } from 'commander'
14 process.title = 'peertube'
16 // Create our main app
17 const app = express().disable('x-powered-by')
19 // ----------- Core checker -----------
20 import { checkMissedConfig, checkFFmpeg, checkNodeVersion } from './server/initializers/checker-before-init'
22 // Do not use barrels because we don't want to load all modules here (we need to initialize database first)
23 import { CONFIG } from './server/initializers/config'
24 import { API_VERSION, FILES_CACHE, WEBSERVER, loadLanguages } from './server/initializers/constants'
25 import { logger } from './server/helpers/logger'
27 const missed = checkMissedConfig()
28 if (missed.length !== 0) {
29 logger.error('Your configuration files miss keys: ' + missed)
35 logger.error('Error in ffmpeg check.', { err })
42 logger.error('Error in NodeJS check.', { err })
46 import { checkConfig, checkActivityPubUrls, checkFFmpegVersion } from './server/initializers/checker-after-init'
51 logger.error('Config error.', { err })
55 // Trust our proxy (IP forwarding...)
56 app.set('trust proxy', CONFIG.TRUST_PROXY)
58 app.use((_req, res, next) => {
59 res.locals.requestStart = Date.now()
64 // Security middleware
65 import { baseCSP } from './server/middlewares/csp'
67 if (CONFIG.CSP.ENABLED) {
71 if (CONFIG.SECURITY.FRAMEGUARD.ENABLED) {
73 action: 'deny' // we only allow it for /videos/embed, see server/controllers/client.ts
77 // ----------- Database -----------
79 // Initialize database and models
80 import { initDatabaseModels, checkDatabaseConnectionOrDie } from './server/initializers/database'
81 checkDatabaseConnectionOrDie()
83 import { migrate } from './server/initializers/migrator'
85 .then(() => initDatabaseModels(false))
86 .then(() => startApplication())
88 logger.error('Cannot start application.', { err })
92 // ----------- Initialize -----------
95 // ----------- PeerTube modules -----------
96 import { installApplication } from './server/initializers/installer'
97 import { Emailer } from './server/lib/emailer'
98 import { JobQueue } from './server/lib/job-queue'
99 import { VideosPreviewCache, VideosCaptionCache } from './server/lib/files-cache'
110 objectStorageProxyRouter,
114 createWebsocketTrackerServer,
117 } from './server/controllers'
118 import { advertiseDoNotTrack } from './server/middlewares/dnt'
119 import { apiFailMiddleware } from './server/middlewares/error'
120 import { Redis } from './server/lib/redis'
121 import { ActorFollowScheduler } from './server/lib/schedulers/actor-follow-scheduler'
122 import { RemoveOldViewsScheduler } from './server/lib/schedulers/remove-old-views-scheduler'
123 import { RemoveOldJobsScheduler } from './server/lib/schedulers/remove-old-jobs-scheduler'
124 import { UpdateVideosScheduler } from './server/lib/schedulers/update-videos-scheduler'
125 import { YoutubeDlUpdateScheduler } from './server/lib/schedulers/youtube-dl-update-scheduler'
126 import { VideosRedundancyScheduler } from './server/lib/schedulers/videos-redundancy-scheduler'
127 import { RemoveOldHistoryScheduler } from './server/lib/schedulers/remove-old-history-scheduler'
128 import { AutoFollowIndexInstances } from './server/lib/schedulers/auto-follow-index-instances'
129 import { RemoveDanglingResumableUploadsScheduler } from './server/lib/schedulers/remove-dangling-resumable-uploads-scheduler'
130 import { VideoViewsBufferScheduler } from './server/lib/schedulers/video-views-buffer-scheduler'
131 import { GeoIPUpdateScheduler } from './server/lib/schedulers/geo-ip-update-scheduler'
132 import { isHTTPSignatureDigestValid } from './server/helpers/peertube-crypto'
133 import { PeerTubeSocket } from './server/lib/peertube-socket'
134 import { updateStreamingPlaylistsInfohashesIfNeeded } from './server/lib/hls'
135 import { PluginsCheckScheduler } from './server/lib/schedulers/plugins-check-scheduler'
136 import { PeerTubeVersionCheckScheduler } from './server/lib/schedulers/peertube-version-check-scheduler'
137 import { Hooks } from './server/lib/plugins/hooks'
138 import { PluginManager } from './server/lib/plugins/plugin-manager'
139 import { LiveManager } from './server/lib/live'
140 import { HttpStatusCode } from './shared/models/http/http-error-codes'
141 import { VideosTorrentCache } from '@server/lib/files-cache/videos-torrent-cache'
142 import { ServerConfigManager } from '@server/lib/server-config-manager'
143 import { VideoViewsManager } from '@server/lib/views/video-views-manager'
144 import { isTestOrDevInstance } from './server/helpers/core-utils'
145 import { OpenTelemetryMetrics } from '@server/lib/opentelemetry/metrics'
146 import { ApplicationModel } from '@server/models/application/application'
147 import { VideoChannelSyncLatestScheduler } from '@server/lib/schedulers/video-channel-sync-latest-scheduler'
149 // ----------- Command line -----------
152 .option('--no-client', 'Start PeerTube without client interface')
153 .option('--no-plugins', 'Start PeerTube without plugins/themes enabled')
154 .option('--benchmark-startup', 'Automatically stop server when initialized')
157 // ----------- App -----------
159 // Enable CORS for develop
160 if (isTestOrDevInstance()) {
163 exposedHeaders: 'Retry-After',
169 token('remote-addr', (req: express.Request) => {
170 if (CONFIG.LOG.ANONYMIZE_IP === true || req.get('DNT') === '1') {
171 return anonymize(req.ip, 16, 16)
176 token('user-agent', (req: express.Request) => {
177 if (req.get('DNT') === '1') {
178 return parse(req.get('user-agent')).family
181 return req.get('user-agent')
183 app.use(morgan('combined', {
185 write: (str: string) => logger.info(str.trim(), { tags: [ 'http' ] })
187 skip: req => CONFIG.LOG.LOG_PING_REQUESTS === false && req.originalUrl === '/api/v1/ping'
190 // Add .fail() helper to response
191 app.use(apiFailMiddleware)
194 app.use(express.urlencoded({ extended: false }))
195 app.use(express.json({
196 type: [ 'application/json', 'application/*+json' ],
198 verify: (req: express.Request, res: express.Response, buf: Buffer) => {
199 const valid = isHTTPSignatureDigestValid(buf, req)
201 if (valid !== true) {
203 status: HttpStatusCode.FORBIDDEN_403,
204 message: 'Invalid digest'
211 app.use(cookieParser())
213 // W3C DNT Tracking Status
214 app.use(advertiseDoNotTrack)
216 // ----------- Open Telemetry -----------
218 OpenTelemetryMetrics.Instance.init(app)
220 // ----------- Views, routes and static files -----------
223 const apiRoute = '/api/' + API_VERSION
224 app.use(apiRoute, apiRouter)
226 // Services (oembed...)
227 app.use('/services', servicesRouter)
230 app.use('/', pluginsRouter)
232 app.use('/', activityPubRouter)
233 app.use('/', feedsRouter)
234 app.use('/', webfingerRouter)
235 app.use('/', trackerRouter)
236 app.use('/', botsRouter)
239 app.use('/', staticRouter)
240 app.use('/', wellKnownRouter)
241 app.use('/', miscRouter)
242 app.use('/', downloadRouter)
243 app.use('/', lazyStaticRouter)
244 app.use('/', objectStorageProxyRouter)
246 // Client files, last valid routes!
247 const cliOptions = cli.opts<{ client: boolean, plugins: boolean }>()
248 if (cliOptions.client) app.use('/', clientsRouter)
250 // ----------- Errors -----------
252 // Catch unmatched routes
253 app.use((_req, res: express.Response) => {
254 res.status(HttpStatusCode.NOT_FOUND_404).end()
257 // Catch thrown errors
258 app.use((err, _req, res: express.Response, _next) => {
259 // Format error to be logged
260 let error = 'Unknown error.'
262 error = err.stack || err.message || err
265 // Handling Sequelize error traces
266 const sql = err?.parent ? err.parent.sql : undefined
268 // Help us to debug SequelizeConnectionAcquireTimeoutError errors
269 const activeRequests = err?.name === 'SequelizeConnectionAcquireTimeoutError' && typeof (process as any)._getActiveRequests !== 'function'
270 ? (process as any)._getActiveRequests()
273 logger.error('Error in controller.', { err: error, sql, activeRequests })
276 status: err.status || HttpStatusCode.INTERNAL_SERVER_ERROR_500,
277 message: err.message,
282 const server = createWebsocketTrackerServer(app)
284 // ----------- Run -----------
286 async function startApplication () {
287 const port = CONFIG.LISTEN.PORT
288 const hostname = CONFIG.LISTEN.HOSTNAME
290 await installApplication()
292 // Check activity pub urls are valid
293 checkActivityPubUrls()
295 logger.error('Error in ActivityPub URLs checker.', { err })
300 .catch(err => logger.error('Cannot check ffmpeg version', { err }))
302 Redis.Instance.init()
303 Emailer.Instance.init()
306 Emailer.Instance.checkConnection(),
307 JobQueue.Instance.init(),
308 ServerConfigManager.Instance.init()
311 // Caches initializations
312 VideosPreviewCache.Instance.init(CONFIG.CACHE.PREVIEWS.SIZE, FILES_CACHE.PREVIEWS.MAX_AGE)
313 VideosCaptionCache.Instance.init(CONFIG.CACHE.VIDEO_CAPTIONS.SIZE, FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE)
314 VideosTorrentCache.Instance.init(CONFIG.CACHE.TORRENTS.SIZE, FILES_CACHE.TORRENTS.MAX_AGE)
317 ActorFollowScheduler.Instance.enable()
318 RemoveOldJobsScheduler.Instance.enable()
319 UpdateVideosScheduler.Instance.enable()
320 YoutubeDlUpdateScheduler.Instance.enable()
321 VideosRedundancyScheduler.Instance.enable()
322 RemoveOldHistoryScheduler.Instance.enable()
323 RemoveOldViewsScheduler.Instance.enable()
324 PluginsCheckScheduler.Instance.enable()
325 PeerTubeVersionCheckScheduler.Instance.enable()
326 AutoFollowIndexInstances.Instance.enable()
327 RemoveDanglingResumableUploadsScheduler.Instance.enable()
328 VideoChannelSyncLatestScheduler.Instance.enable()
329 VideoViewsBufferScheduler.Instance.enable()
330 GeoIPUpdateScheduler.Instance.enable()
331 OpenTelemetryMetrics.Instance.registerMetrics()
333 PluginManager.Instance.init(server)
334 // Before PeerTubeSocket init
335 PluginManager.Instance.registerWebSocketRouter()
337 PeerTubeSocket.Instance.init(server)
338 VideoViewsManager.Instance.init()
340 updateStreamingPlaylistsInfohashesIfNeeded()
341 .catch(err => logger.error('Cannot update streaming playlist infohashes.', { err }))
343 LiveManager.Instance.init()
344 if (CONFIG.LIVE.ENABLED) await LiveManager.Instance.run()
346 // Make server listening
347 server.listen(port, hostname, async () => {
348 if (cliOptions.plugins) {
350 await PluginManager.Instance.rebuildNativePluginsIfNeeded()
352 await PluginManager.Instance.registerPluginsAndThemes()
354 logger.error('Cannot register plugins and themes.', { err })
358 ApplicationModel.updateNodeVersions()
359 .catch(err => logger.error('Cannot update node versions.', { err }))
361 JobQueue.Instance.start()
363 logger.error('Cannot start job queue.', { err })
367 logger.info('HTTP server listening on %s:%d', hostname, port)
368 logger.info('Web server: %s', WEBSERVER.URL)
370 Hooks.runAction('action:application.listening')
372 if (cliOptions['benchmarkStartup']) process.exit(0)
375 process.on('exit', () => {
376 JobQueue.Instance.terminate()
377 .catch(err => logger.error('Cannot terminate job queue.', { err }))
380 process.on('SIGINT', () => process.exit(0))