server.ts

   1 // ----------- Node modules -----------
   2 import { registerOpentelemetryTracing } from './server/lib/opentelemetry/tracing'
   3 registerOpentelemetryTracing()
   4
   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'
  13
  14 process.title = 'peertube'
  15
  16 // Create our main app
  17 const app = express().disable('x-powered-by')
  18
  19 // ----------- Core checker -----------
  20 import { checkMissedConfig, checkFFmpeg, checkNodeVersion } from './server/initializers/checker-before-init'
  21
  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'
  26
  27 const missed = checkMissedConfig()
  28 if (missed.length !== 0) {
  29   logger.error('Your configuration files miss keys: ' + missed)
  30   process.exit(-1)
  31 }
  32
  33 checkFFmpeg(CONFIG)
  34   .catch(err => {
  35     logger.error('Error in ffmpeg check.', { err })
  36     process.exit(-1)
  37   })
  38
  39 try {
  40   checkNodeVersion()
  41 } catch (err) {
  42   logger.error('Error in NodeJS check.', { err })
  43   process.exit(-1)
  44 }
  45
  46 import { checkConfig, checkActivityPubUrls, checkFFmpegVersion } from './server/initializers/checker-after-init'
  47
  48 checkConfig()
  49
  50 // Trust our proxy (IP forwarding...)
  51 app.set('trust proxy', CONFIG.TRUST_PROXY)
  52
  53 app.use((_req, res, next) => {
  54   res.locals.requestStart = Date.now()
  55
  56   return next()
  57 })
  58
  59 // Security middleware
  60 import { baseCSP } from './server/middlewares/csp'
  61
  62 if (CONFIG.CSP.ENABLED) {
  63   app.use(baseCSP)
  64 }
  65
  66 if (CONFIG.SECURITY.FRAMEGUARD.ENABLED) {
  67   app.use(frameguard({
  68     action: 'deny' // we only allow it for /videos/embed, see server/controllers/client.ts
  69   }))
  70 }
  71
  72 // ----------- Database -----------
  73
  74 // Initialize database and models
  75 import { initDatabaseModels, checkDatabaseConnectionOrDie } from './server/initializers/database'
  76 checkDatabaseConnectionOrDie()
  77
  78 import { migrate } from './server/initializers/migrator'
  79 migrate()
  80   .then(() => initDatabaseModels(false))
  81   .then(() => startApplication())
  82   .catch(err => {
  83     logger.error('Cannot start application.', { err })
  84     process.exit(-1)
  85   })
  86
  87 // ----------- Initialize -----------
  88 loadLanguages()
  89
  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'
  95 import {
  96   activityPubRouter,
  97   apiRouter,
  98   miscRouter,
  99   clientsRouter,
 100   feedsRouter,
 101   staticRouter,
 102   wellKnownRouter,
 103   lazyStaticRouter,
 104   servicesRouter,
 105   pluginsRouter,
 106   webfingerRouter,
 107   trackerRouter,
 108   createWebsocketTrackerServer,
 109   botsRouter,
 110   downloadRouter
 111 } from './server/controllers'
 112 import { advertiseDoNotTrack } from './server/middlewares/dnt'
 113 import { apiFailMiddleware } from './server/middlewares/error'
 114 import { Redis } from './server/lib/redis'
 115 import { ActorFollowScheduler } from './server/lib/schedulers/actor-follow-scheduler'
 116 import { RemoveOldViewsScheduler } from './server/lib/schedulers/remove-old-views-scheduler'
 117 import { RemoveOldJobsScheduler } from './server/lib/schedulers/remove-old-jobs-scheduler'
 118 import { UpdateVideosScheduler } from './server/lib/schedulers/update-videos-scheduler'
 119 import { YoutubeDlUpdateScheduler } from './server/lib/schedulers/youtube-dl-update-scheduler'
 120 import { VideosRedundancyScheduler } from './server/lib/schedulers/videos-redundancy-scheduler'
 121 import { RemoveOldHistoryScheduler } from './server/lib/schedulers/remove-old-history-scheduler'
 122 import { AutoFollowIndexInstances } from './server/lib/schedulers/auto-follow-index-instances'
 123 import { RemoveDanglingResumableUploadsScheduler } from './server/lib/schedulers/remove-dangling-resumable-uploads-scheduler'
 124 import { VideoViewsBufferScheduler } from './server/lib/schedulers/video-views-buffer-scheduler'
 125 import { GeoIPUpdateScheduler } from './server/lib/schedulers/geo-ip-update-scheduler'
 126 import { isHTTPSignatureDigestValid } from './server/helpers/peertube-crypto'
 127 import { PeerTubeSocket } from './server/lib/peertube-socket'
 128 import { updateStreamingPlaylistsInfohashesIfNeeded } from './server/lib/hls'
 129 import { PluginsCheckScheduler } from './server/lib/schedulers/plugins-check-scheduler'
 130 import { PeerTubeVersionCheckScheduler } from './server/lib/schedulers/peertube-version-check-scheduler'
 131 import { Hooks } from './server/lib/plugins/hooks'
 132 import { PluginManager } from './server/lib/plugins/plugin-manager'
 133 import { LiveManager } from './server/lib/live'
 134 import { HttpStatusCode } from './shared/models/http/http-error-codes'
 135 import { VideosTorrentCache } from '@server/lib/files-cache/videos-torrent-cache'
 136 import { ServerConfigManager } from '@server/lib/server-config-manager'
 137 import { VideoViewsManager } from '@server/lib/views/video-views-manager'
 138 import { isTestOrDevInstance } from './server/helpers/core-utils'
 139 import { OpenTelemetryMetrics } from '@server/lib/opentelemetry/metrics'
 140 import { ApplicationModel } from '@server/models/application/application'
 141 import { VideoChannelSyncLatestScheduler } from '@server/lib/schedulers/video-channel-sync-latest-scheduler'
 142
 143 // ----------- Command line -----------
 144
 145 cli
 146   .option('--no-client', 'Start PeerTube without client interface')
 147   .option('--no-plugins', 'Start PeerTube without plugins/themes enabled')
 148   .option('--benchmark-startup', 'Automatically stop server when initialized')
 149   .parse(process.argv)
 150
 151 // ----------- App -----------
 152
 153 // Enable CORS for develop
 154 if (isTestOrDevInstance()) {
 155   app.use(cors({
 156     origin: '*',
 157     exposedHeaders: 'Retry-After',
 158     credentials: true
 159   }))
 160 }
 161
 162 // For the logger
 163 token('remote-addr', (req: express.Request) => {
 164   if (CONFIG.LOG.ANONYMIZE_IP === true || req.get('DNT') === '1') {
 165     return anonymize(req.ip, 16, 16)
 166   }
 167
 168   return req.ip
 169 })
 170 token('user-agent', (req: express.Request) => {
 171   if (req.get('DNT') === '1') {
 172     return parse(req.get('user-agent')).family
 173   }
 174
 175   return req.get('user-agent')
 176 })
 177 app.use(morgan('combined', {
 178   stream: {
 179     write: (str: string) => logger.info(str.trim(), { tags: [ 'http' ] })
 180   },
 181   skip: req => CONFIG.LOG.LOG_PING_REQUESTS === false && req.originalUrl === '/api/v1/ping'
 182 }))
 183
 184 // Add .fail() helper to response
 185 app.use(apiFailMiddleware)
 186
 187 // For body requests
 188 app.use(express.urlencoded({ extended: false }))
 189 app.use(express.json({
 190   type: [ 'application/json', 'application/*+json' ],
 191   limit: '500kb',
 192   verify: (req: express.Request, res: express.Response, buf: Buffer) => {
 193     const valid = isHTTPSignatureDigestValid(buf, req)
 194
 195     if (valid !== true) {
 196       res.fail({
 197         status: HttpStatusCode.FORBIDDEN_403,
 198         message: 'Invalid digest'
 199       })
 200     }
 201   }
 202 }))
 203
 204 // Cookies
 205 app.use(cookieParser())
 206
 207 // W3C DNT Tracking Status
 208 app.use(advertiseDoNotTrack)
 209
 210 // ----------- Open Telemetry -----------
 211
 212 OpenTelemetryMetrics.Instance.init(app)
 213
 214 // ----------- Views, routes and static files -----------
 215
 216 // API
 217 const apiRoute = '/api/' + API_VERSION
 218 app.use(apiRoute, apiRouter)
 219
 220 // Services (oembed...)
 221 app.use('/services', servicesRouter)
 222
 223 // Plugins & themes
 224 app.use('/', pluginsRouter)
 225
 226 app.use('/', activityPubRouter)
 227 app.use('/', feedsRouter)
 228 app.use('/', webfingerRouter)
 229 app.use('/', trackerRouter)
 230 app.use('/', botsRouter)
 231
 232 // Static files
 233 app.use('/', staticRouter)
 234 app.use('/', wellKnownRouter)
 235 app.use('/', miscRouter)
 236 app.use('/', downloadRouter)
 237 app.use('/', lazyStaticRouter)
 238
 239 // Client files, last valid routes!
 240 const cliOptions = cli.opts<{ client: boolean, plugins: boolean }>()
 241 if (cliOptions.client) app.use('/', clientsRouter)
 242
 243 // ----------- Errors -----------
 244
 245 // Catch unmatched routes
 246 app.use((_req, res: express.Response) => {
 247   res.status(HttpStatusCode.NOT_FOUND_404).end()
 248 })
 249
 250 // Catch thrown errors
 251 app.use((err, _req, res: express.Response, _next) => {
 252   // Format error to be logged
 253   let error = 'Unknown error.'
 254   if (err) {
 255     error = err.stack || err.message || err
 256   }
 257
 258   // Handling Sequelize error traces
 259   const sql = err?.parent ? err.parent.sql : undefined
 260
 261   // Help us to debug SequelizeConnectionAcquireTimeoutError errors
 262   const activeRequests = err?.name === 'SequelizeConnectionAcquireTimeoutError' && typeof (process as any)._getActiveRequests !== 'function'
 263     ? (process as any)._getActiveRequests()
 264     : undefined
 265
 266   logger.error('Error in controller.', { err: error, sql, activeRequests })
 267
 268   return res.fail({
 269     status: err.status || HttpStatusCode.INTERNAL_SERVER_ERROR_500,
 270     message: err.message,
 271     type: err.name
 272   })
 273 })
 274
 275 const server = createWebsocketTrackerServer(app)
 276
 277 // ----------- Run -----------
 278
 279 async function startApplication () {
 280   const port = CONFIG.LISTEN.PORT
 281   const hostname = CONFIG.LISTEN.HOSTNAME
 282
 283   await installApplication()
 284
 285   // Check activity pub urls are valid
 286   checkActivityPubUrls()
 287     .catch(err => {
 288       logger.error('Error in ActivityPub URLs checker.', { err })
 289       process.exit(-1)
 290     })
 291
 292   checkFFmpegVersion()
 293     .catch(err => logger.error('Cannot check ffmpeg version', { err }))
 294
 295   Redis.Instance.init()
 296   Emailer.Instance.init()
 297
 298   await Promise.all([
 299     Emailer.Instance.checkConnection(),
 300     JobQueue.Instance.init(),
 301     ServerConfigManager.Instance.init()
 302   ])
 303
 304   // Caches initializations
 305   VideosPreviewCache.Instance.init(CONFIG.CACHE.PREVIEWS.SIZE, FILES_CACHE.PREVIEWS.MAX_AGE)
 306   VideosCaptionCache.Instance.init(CONFIG.CACHE.VIDEO_CAPTIONS.SIZE, FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE)
 307   VideosTorrentCache.Instance.init(CONFIG.CACHE.TORRENTS.SIZE, FILES_CACHE.TORRENTS.MAX_AGE)
 308
 309   // Enable Schedulers
 310   ActorFollowScheduler.Instance.enable()
 311   RemoveOldJobsScheduler.Instance.enable()
 312   UpdateVideosScheduler.Instance.enable()
 313   YoutubeDlUpdateScheduler.Instance.enable()
 314   VideosRedundancyScheduler.Instance.enable()
 315   RemoveOldHistoryScheduler.Instance.enable()
 316   RemoveOldViewsScheduler.Instance.enable()
 317   PluginsCheckScheduler.Instance.enable()
 318   PeerTubeVersionCheckScheduler.Instance.enable()
 319   AutoFollowIndexInstances.Instance.enable()
 320   RemoveDanglingResumableUploadsScheduler.Instance.enable()
 321   VideoChannelSyncLatestScheduler.Instance.enable()
 322   VideoViewsBufferScheduler.Instance.enable()
 323   GeoIPUpdateScheduler.Instance.enable()
 324   OpenTelemetryMetrics.Instance.registerMetrics()
 325
 326   PeerTubeSocket.Instance.init(server)
 327   VideoViewsManager.Instance.init()
 328
 329   updateStreamingPlaylistsInfohashesIfNeeded()
 330     .catch(err => logger.error('Cannot update streaming playlist infohashes.', { err }))
 331
 332   LiveManager.Instance.init()
 333   if (CONFIG.LIVE.ENABLED) await LiveManager.Instance.run()
 334
 335   // Make server listening
 336   server.listen(port, hostname, async () => {
 337     if (cliOptions.plugins) {
 338       try {
 339         await PluginManager.Instance.rebuildNativePluginsIfNeeded()
 340
 341         await PluginManager.Instance.registerPluginsAndThemes()
 342       } catch (err) {
 343         logger.error('Cannot register plugins and themes.', { err })
 344       }
 345     }
 346
 347     ApplicationModel.updateNodeVersions()
 348       .catch(err => logger.error('Cannot update node versions.', { err }))
 349
 350     JobQueue.Instance.start()
 351       .catch(err => {
 352         logger.error('Cannot start job queue.', { err })
 353         process.exit(-1)
 354       })
 355
 356     logger.info('HTTP server listening on %s:%d', hostname, port)
 357     logger.info('Web server: %s', WEBSERVER.URL)
 358
 359     Hooks.runAction('action:application.listening')
 360
 361     if (cliOptions['benchmarkStartup']) process.exit(0)
 362   })
 363
 364   process.on('exit', () => {
 365     JobQueue.Instance.terminate()
 366       .catch(err => logger.error('Cannot terminate job queue.', { err }))
 367   })
 368
 369   process.on('SIGINT', () => process.exit(0))
 370 }