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'
50 // Trust our proxy (IP forwarding...)
51 app.set('trust proxy', CONFIG.TRUST_PROXY)
53 app.use((_req, res, next) => {
54 res.locals.requestStart = Date.now()
59 // Security middleware
60 import { baseCSP } from './server/middlewares/csp'
62 if (CONFIG.CSP.ENABLED) {
66 if (CONFIG.SECURITY.FRAMEGUARD.ENABLED) {
68 action: 'deny' // we only allow it for /videos/embed, see server/controllers/client.ts
72 // ----------- Database -----------
74 // Initialize database and models
75 import { initDatabaseModels, checkDatabaseConnectionOrDie } from './server/initializers/database'
76 checkDatabaseConnectionOrDie()
78 import { migrate } from './server/initializers/migrator'
80 .then(() => initDatabaseModels(false))
81 .then(() => startApplication())
83 logger.error('Cannot start application.', { err })
87 // ----------- Initialize -----------
90 // ----------- PeerTube modules -----------
91 import { installApplication } from './server/initializers/installer'
92 import { Emailer } from './server/lib/emailer'
93 import { JobQueue } from './server/lib/job-queue'
94 import { VideosPreviewCache, VideosCaptionCache } from './server/lib/files-cache'
109 createWebsocketTrackerServer,
112 } from './server/controllers'
113 import { advertiseDoNotTrack } from './server/middlewares/dnt'
114 import { apiFailMiddleware } from './server/middlewares/error'
115 import { Redis } from './server/lib/redis'
116 import { ActorFollowScheduler } from './server/lib/schedulers/actor-follow-scheduler'
117 import { RemoveOldViewsScheduler } from './server/lib/schedulers/remove-old-views-scheduler'
118 import { RemoveOldJobsScheduler } from './server/lib/schedulers/remove-old-jobs-scheduler'
119 import { UpdateVideosScheduler } from './server/lib/schedulers/update-videos-scheduler'
120 import { YoutubeDlUpdateScheduler } from './server/lib/schedulers/youtube-dl-update-scheduler'
121 import { VideosRedundancyScheduler } from './server/lib/schedulers/videos-redundancy-scheduler'
122 import { RemoveOldHistoryScheduler } from './server/lib/schedulers/remove-old-history-scheduler'
123 import { AutoFollowIndexInstances } from './server/lib/schedulers/auto-follow-index-instances'
124 import { RemoveDanglingResumableUploadsScheduler } from './server/lib/schedulers/remove-dangling-resumable-uploads-scheduler'
125 import { VideoViewsBufferScheduler } from './server/lib/schedulers/video-views-buffer-scheduler'
126 import { GeoIPUpdateScheduler } from './server/lib/schedulers/geo-ip-update-scheduler'
127 import { isHTTPSignatureDigestValid } from './server/helpers/peertube-crypto'
128 import { PeerTubeSocket } from './server/lib/peertube-socket'
129 import { updateStreamingPlaylistsInfohashesIfNeeded } from './server/lib/hls'
130 import { PluginsCheckScheduler } from './server/lib/schedulers/plugins-check-scheduler'
131 import { PeerTubeVersionCheckScheduler } from './server/lib/schedulers/peertube-version-check-scheduler'
132 import { Hooks } from './server/lib/plugins/hooks'
133 import { PluginManager } from './server/lib/plugins/plugin-manager'
134 import { LiveManager } from './server/lib/live'
135 import { HttpStatusCode } from './shared/models/http/http-error-codes'
136 import { VideosTorrentCache } from '@server/lib/files-cache/videos-torrent-cache'
137 import { ServerConfigManager } from '@server/lib/server-config-manager'
138 import { VideoViewsManager } from '@server/lib/views/video-views-manager'
139 import { isTestOrDevInstance } from './server/helpers/core-utils'
140 import { OpenTelemetryMetrics } from '@server/lib/opentelemetry/metrics'
142 // ----------- Command line -----------
145 .option('--no-client', 'Start PeerTube without client interface')
146 .option('--no-plugins', 'Start PeerTube without plugins/themes enabled')
147 .option('--benchmark-startup', 'Automatically stop server when initialized')
150 // ----------- App -----------
152 // Enable CORS for develop
153 if (isTestOrDevInstance()) {
156 exposedHeaders: 'Retry-After',
162 token('remote-addr', (req: express.Request) => {
163 if (CONFIG.LOG.ANONYMIZE_IP === true || req.get('DNT') === '1') {
164 return anonymize(req.ip, 16, 16)
169 token('user-agent', (req: express.Request) => {
170 if (req.get('DNT') === '1') {
171 return parse(req.get('user-agent')).family
174 return req.get('user-agent')
176 app.use(morgan('combined', {
178 write: (str: string) => logger.info(str.trim(), { tags: [ 'http' ] })
180 skip: req => CONFIG.LOG.LOG_PING_REQUESTS === false && req.originalUrl === '/api/v1/ping'
183 // Add .fail() helper to response
184 app.use(apiFailMiddleware)
187 app.use(express.urlencoded({ extended: false }))
188 app.use(express.json({
189 type: [ 'application/json', 'application/*+json' ],
191 verify: (req: express.Request, res: express.Response, buf: Buffer) => {
192 const valid = isHTTPSignatureDigestValid(buf, req)
194 if (valid !== true) {
196 status: HttpStatusCode.FORBIDDEN_403,
197 message: 'Invalid digest'
204 app.use(cookieParser())
206 // W3C DNT Tracking Status
207 app.use(advertiseDoNotTrack)
209 // ----------- Open Telemetry -----------
211 OpenTelemetryMetrics.Instance.init(app)
213 // ----------- Views, routes and static files -----------
216 const apiRoute = '/api/' + API_VERSION
217 app.use(apiRoute, apiRouter)
219 // Services (oembed...)
220 app.use('/services', servicesRouter)
223 app.use('/live', liveRouter)
226 app.use('/', pluginsRouter)
228 app.use('/', activityPubRouter)
229 app.use('/', feedsRouter)
230 app.use('/', webfingerRouter)
231 app.use('/', trackerRouter)
232 app.use('/', botsRouter)
235 app.use('/', staticRouter)
236 app.use('/', wellKnownRouter)
237 app.use('/', miscRouter)
238 app.use('/', downloadRouter)
239 app.use('/', lazyStaticRouter)
241 // Client files, last valid routes!
242 const cliOptions = cli.opts<{ client: boolean, plugins: boolean }>()
243 if (cliOptions.client) app.use('/', clientsRouter)
245 // ----------- Errors -----------
247 // Catch unmatched routes
248 app.use((_req, res: express.Response) => {
249 res.status(HttpStatusCode.NOT_FOUND_404).end()
252 // Catch thrown errors
253 app.use((err, _req, res: express.Response, _next) => {
254 // Format error to be logged
255 let error = 'Unknown error.'
257 error = err.stack || err.message || err
259 // Handling Sequelize error traces
260 const sql = err.parent ? err.parent.sql : undefined
261 logger.error('Error in controller.', { err: error, sql })
264 status: err.status || HttpStatusCode.INTERNAL_SERVER_ERROR_500,
265 message: err.message,
270 const server = createWebsocketTrackerServer(app)
272 // ----------- Run -----------
274 async function startApplication () {
275 const port = CONFIG.LISTEN.PORT
276 const hostname = CONFIG.LISTEN.HOSTNAME
278 await installApplication()
280 // Check activity pub urls are valid
281 checkActivityPubUrls()
283 logger.error('Error in ActivityPub URLs checker.', { err })
288 .catch(err => logger.error('Cannot check ffmpeg version', { err }))
290 Redis.Instance.init()
291 Emailer.Instance.init()
294 Emailer.Instance.checkConnection(),
295 JobQueue.Instance.init(),
296 ServerConfigManager.Instance.init()
299 // Caches initializations
300 VideosPreviewCache.Instance.init(CONFIG.CACHE.PREVIEWS.SIZE, FILES_CACHE.PREVIEWS.MAX_AGE)
301 VideosCaptionCache.Instance.init(CONFIG.CACHE.VIDEO_CAPTIONS.SIZE, FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE)
302 VideosTorrentCache.Instance.init(CONFIG.CACHE.TORRENTS.SIZE, FILES_CACHE.TORRENTS.MAX_AGE)
305 ActorFollowScheduler.Instance.enable()
306 RemoveOldJobsScheduler.Instance.enable()
307 UpdateVideosScheduler.Instance.enable()
308 YoutubeDlUpdateScheduler.Instance.enable()
309 VideosRedundancyScheduler.Instance.enable()
310 RemoveOldHistoryScheduler.Instance.enable()
311 RemoveOldViewsScheduler.Instance.enable()
312 PluginsCheckScheduler.Instance.enable()
313 PeerTubeVersionCheckScheduler.Instance.enable()
314 AutoFollowIndexInstances.Instance.enable()
315 RemoveDanglingResumableUploadsScheduler.Instance.enable()
316 VideoViewsBufferScheduler.Instance.enable()
317 GeoIPUpdateScheduler.Instance.enable()
318 OpenTelemetryMetrics.Instance.registerMetrics()
320 PeerTubeSocket.Instance.init(server)
321 VideoViewsManager.Instance.init()
323 updateStreamingPlaylistsInfohashesIfNeeded()
324 .catch(err => logger.error('Cannot update streaming playlist infohashes.', { err }))
326 LiveManager.Instance.init()
327 if (CONFIG.LIVE.ENABLED) await LiveManager.Instance.run()
329 // Make server listening
330 server.listen(port, hostname, async () => {
331 if (cliOptions.plugins) {
333 await PluginManager.Instance.registerPluginsAndThemes()
335 logger.error('Cannot register plugins and themes.', { err })
339 logger.info('HTTP server listening on %s:%d', hostname, port)
340 logger.info('Web server: %s', WEBSERVER.URL)
342 Hooks.runAction('action:application.listening')
344 if (cliOptions['benchmarkStartup']) process.exit(0)
347 process.on('exit', () => {
348 JobQueue.Instance.terminate()
351 process.on('SIGINT', () => process.exit(0))