1 import { registerTSPaths } from './server/helpers/register-ts-paths'
4 import { isTestInstance } from './server/helpers/core-utils'
5 if (isTestInstance()) {
6 require('source-map-support').install()
9 // ----------- Node modules -----------
10 import express from 'express'
11 import morgan, { token } from 'morgan'
12 import cors from 'cors'
13 import cookieParser from 'cookie-parser'
14 import { frameguard } from 'helmet'
15 import { parse } from 'useragent'
16 import anonymize from 'ip-anonymize'
17 import { program as cli } from 'commander'
19 process.title = 'peertube'
21 // Create our main app
22 const app = express().disable("x-powered-by")
24 // ----------- Core checker -----------
25 import { checkMissedConfig, checkFFmpeg, checkNodeVersion } from './server/initializers/checker-before-init'
27 // Do not use barrels because we don't want to load all modules here (we need to initialize database first)
28 import { CONFIG } from './server/initializers/config'
29 import { API_VERSION, FILES_CACHE, WEBSERVER, loadLanguages } from './server/initializers/constants'
30 import { logger } from './server/helpers/logger'
32 const missed = checkMissedConfig()
33 if (missed.length !== 0) {
34 logger.error('Your configuration files miss keys: ' + missed)
40 logger.error('Error in ffmpeg check.', { err })
46 import { checkConfig, checkActivityPubUrls, checkFFmpegVersion } from './server/initializers/checker-after-init'
48 const errorMessage = checkConfig()
49 if (errorMessage !== null) {
50 throw new Error(errorMessage)
53 // Trust our proxy (IP forwarding...)
54 app.set('trust proxy', CONFIG.TRUST_PROXY)
56 // Security middleware
57 import { baseCSP } from './server/middlewares/csp'
59 if (CONFIG.CSP.ENABLED) {
63 if (CONFIG.SECURITY.FRAMEGUARD.ENABLED) {
65 action: 'deny' // we only allow it for /videos/embed, see server/controllers/client.ts
69 // ----------- Database -----------
71 // Initialize database and models
72 import { initDatabaseModels, checkDatabaseConnectionOrDie } from './server/initializers/database'
73 checkDatabaseConnectionOrDie()
75 import { migrate } from './server/initializers/migrator'
77 .then(() => initDatabaseModels(false))
78 .then(() => startApplication())
80 logger.error('Cannot start application.', { err })
84 // ----------- Initialize -----------
87 // ----------- PeerTube modules -----------
88 import { installApplication } from './server/initializers/installer'
89 import { Emailer } from './server/lib/emailer'
90 import { JobQueue } from './server/lib/job-queue'
91 import { VideosPreviewCache, VideosCaptionCache } from './server/lib/files-cache'
104 createWebsocketTrackerServer,
107 } from './server/controllers'
108 import { advertiseDoNotTrack } from './server/middlewares/dnt'
109 import { apiFailMiddleware } from './server/middlewares/error'
110 import { Redis } from './server/lib/redis'
111 import { ActorFollowScheduler } from './server/lib/schedulers/actor-follow-scheduler'
112 import { RemoveOldViewsScheduler } from './server/lib/schedulers/remove-old-views-scheduler'
113 import { RemoveOldJobsScheduler } from './server/lib/schedulers/remove-old-jobs-scheduler'
114 import { UpdateVideosScheduler } from './server/lib/schedulers/update-videos-scheduler'
115 import { YoutubeDlUpdateScheduler } from './server/lib/schedulers/youtube-dl-update-scheduler'
116 import { VideosRedundancyScheduler } from './server/lib/schedulers/videos-redundancy-scheduler'
117 import { RemoveOldHistoryScheduler } from './server/lib/schedulers/remove-old-history-scheduler'
118 import { AutoFollowIndexInstances } from './server/lib/schedulers/auto-follow-index-instances'
119 import { RemoveDanglingResumableUploadsScheduler } from './server/lib/schedulers/remove-dangling-resumable-uploads-scheduler'
120 import { VideoViewsBufferScheduler } from './server/lib/schedulers/video-views-buffer-scheduler'
121 import { isHTTPSignatureDigestValid } from './server/helpers/peertube-crypto'
122 import { PeerTubeSocket } from './server/lib/peertube-socket'
123 import { updateStreamingPlaylistsInfohashesIfNeeded } from './server/lib/hls'
124 import { PluginsCheckScheduler } from './server/lib/schedulers/plugins-check-scheduler'
125 import { PeerTubeVersionCheckScheduler } from './server/lib/schedulers/peertube-version-check-scheduler'
126 import { Hooks } from './server/lib/plugins/hooks'
127 import { PluginManager } from './server/lib/plugins/plugin-manager'
128 import { LiveManager } from './server/lib/live'
129 import { HttpStatusCode } from './shared/models/http/http-error-codes'
130 import { VideosTorrentCache } from '@server/lib/files-cache/videos-torrent-cache'
131 import { ServerConfigManager } from '@server/lib/server-config-manager'
132 import { VideoViews } from '@server/lib/video-views'
134 // ----------- Command line -----------
137 .option('--no-client', 'Start PeerTube without client interface')
138 .option('--no-plugins', 'Start PeerTube without plugins/themes enabled')
139 .option('--benchmark-startup', 'Automatically stop server when initialized')
142 // ----------- App -----------
144 // Enable CORS for develop
145 if (isTestInstance()) {
148 exposedHeaders: 'Retry-After',
154 token('remote-addr', (req: express.Request) => {
155 if (CONFIG.LOG.ANONYMIZE_IP === true || req.get('DNT') === '1') {
156 return anonymize(req.ip, 16, 16)
161 token('user-agent', (req: express.Request) => {
162 if (req.get('DNT') === '1') {
163 return parse(req.get('user-agent')).family
166 return req.get('user-agent')
168 app.use(morgan('combined', {
170 write: (str: string) => logger.info(str.trim(), { tags: [ 'http' ] })
172 skip: req => CONFIG.LOG.LOG_PING_REQUESTS === false && req.originalUrl === '/api/v1/ping'
175 // Add .fail() helper to response
176 app.use(apiFailMiddleware)
179 app.use(express.urlencoded({ extended: false }))
180 app.use(express.json({
181 type: [ 'application/json', 'application/*+json' ],
183 verify: (req: express.Request, res: express.Response, buf: Buffer) => {
184 const valid = isHTTPSignatureDigestValid(buf, req)
186 if (valid !== true) {
188 status: HttpStatusCode.FORBIDDEN_403,
189 message: 'Invalid digest'
196 app.use(cookieParser())
198 // W3C DNT Tracking Status
199 app.use(advertiseDoNotTrack)
201 // ----------- Views, routes and static files -----------
204 const apiRoute = '/api/' + API_VERSION
205 app.use(apiRoute, apiRouter)
207 // Services (oembed...)
208 app.use('/services', servicesRouter)
211 app.use('/live', liveRouter)
214 app.use('/', pluginsRouter)
216 app.use('/', activityPubRouter)
217 app.use('/', feedsRouter)
218 app.use('/', webfingerRouter)
219 app.use('/', trackerRouter)
220 app.use('/', botsRouter)
223 app.use('/', staticRouter)
224 app.use('/', downloadRouter)
225 app.use('/', lazyStaticRouter)
227 // Client files, last valid routes!
228 const cliOptions = cli.opts()
229 if (cliOptions.client) app.use('/', clientsRouter)
231 // ----------- Errors -----------
233 // Catch unmatched routes
234 app.use((req, res: express.Response) => {
235 res.status(HttpStatusCode.NOT_FOUND_404).end()
238 // Catch thrown errors
239 app.use((err, req, res: express.Response, next) => {
240 // Format error to be logged
241 let error = 'Unknown error.'
243 error = err.stack || err.message || err
245 // Handling Sequelize error traces
246 const sql = err.parent ? err.parent.sql : undefined
247 logger.error('Error in controller.', { err: error, sql })
250 status: err.status || HttpStatusCode.INTERNAL_SERVER_ERROR_500,
251 message: err.message,
256 const server = createWebsocketTrackerServer(app)
258 // ----------- Run -----------
260 async function startApplication () {
261 const port = CONFIG.LISTEN.PORT
262 const hostname = CONFIG.LISTEN.HOSTNAME
264 await installApplication()
266 // Check activity pub urls are valid
267 checkActivityPubUrls()
269 logger.error('Error in ActivityPub URLs checker.', { err })
274 .catch(err => logger.error('Cannot check ffmpeg version', { err }))
276 // Email initialization
277 Emailer.Instance.init()
280 Emailer.Instance.checkConnection(),
281 JobQueue.Instance.init(),
282 ServerConfigManager.Instance.init()
285 // Caches initializations
286 VideosPreviewCache.Instance.init(CONFIG.CACHE.PREVIEWS.SIZE, FILES_CACHE.PREVIEWS.MAX_AGE)
287 VideosCaptionCache.Instance.init(CONFIG.CACHE.VIDEO_CAPTIONS.SIZE, FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE)
288 VideosTorrentCache.Instance.init(CONFIG.CACHE.TORRENTS.SIZE, FILES_CACHE.TORRENTS.MAX_AGE)
291 ActorFollowScheduler.Instance.enable()
292 RemoveOldJobsScheduler.Instance.enable()
293 UpdateVideosScheduler.Instance.enable()
294 YoutubeDlUpdateScheduler.Instance.enable()
295 VideosRedundancyScheduler.Instance.enable()
296 RemoveOldHistoryScheduler.Instance.enable()
297 RemoveOldViewsScheduler.Instance.enable()
298 PluginsCheckScheduler.Instance.enable()
299 PeerTubeVersionCheckScheduler.Instance.enable()
300 AutoFollowIndexInstances.Instance.enable()
301 RemoveDanglingResumableUploadsScheduler.Instance.enable()
302 VideoViewsBufferScheduler.Instance.enable()
304 Redis.Instance.init()
305 PeerTubeSocket.Instance.init(server)
306 VideoViews.Instance.init()
308 updateStreamingPlaylistsInfohashesIfNeeded()
309 .catch(err => logger.error('Cannot update streaming playlist infohashes.', { err }))
311 LiveManager.Instance.init()
312 if (CONFIG.LIVE.ENABLED) await LiveManager.Instance.run()
314 // Make server listening
315 server.listen(port, hostname, async () => {
316 if (cliOptions.plugins) {
318 await PluginManager.Instance.registerPluginsAndThemes()
320 logger.error('Cannot register plugins and themes.', { err })
324 logger.info('HTTP server listening on %s:%d', hostname, port)
325 logger.info('Web server: %s', WEBSERVER.URL)
327 Hooks.runAction('action:application.listening')
329 if (cliOptions['benchmarkStartup']) process.exit(0)
332 process.on('exit', () => {
333 JobQueue.Instance.terminate()
336 process.on('SIGINT', () => process.exit(0))