Merge branch 'release/v1.2.0'
[oweals/peertube.git] / server.ts
1 // FIXME: https://github.com/nodejs/node/pull/16853
2 require('tls').DEFAULT_ECDH_CURVE = 'auto'
3
4 import { isTestInstance } from './server/helpers/core-utils'
5
6 if (isTestInstance()) {
7   require('source-map-support').install()
8 }
9
10 // ----------- Node modules -----------
11 import * as bodyParser from 'body-parser'
12 import * as express from 'express'
13 import * as morgan from 'morgan'
14 import * as cors from 'cors'
15 import * as cookieParser from 'cookie-parser'
16 import * as helmet from 'helmet'
17 import * as useragent from 'useragent'
18 import * as anonymize from 'ip-anonymize'
19 import * as cli from 'commander'
20
21 process.title = 'peertube'
22
23 // Create our main app
24 const app = express()
25
26 // ----------- Core checker -----------
27 import { checkMissedConfig, checkFFmpeg } from './server/initializers/checker-before-init'
28
29 // Do not use barrels because we don't want to load all modules here (we need to initialize database first)
30 import { logger } from './server/helpers/logger'
31 import { API_VERSION, CONFIG, CACHE } from './server/initializers/constants'
32
33 const missed = checkMissedConfig()
34 if (missed.length !== 0) {
35   logger.error('Your configuration files miss keys: ' + missed)
36   process.exit(-1)
37 }
38
39 checkFFmpeg(CONFIG)
40   .catch(err => {
41     logger.error('Error in ffmpeg check.', { err })
42     process.exit(-1)
43   })
44
45 import { checkConfig, checkActivityPubUrls } from './server/initializers/checker-after-init'
46
47 const errorMessage = checkConfig()
48 if (errorMessage !== null) {
49   throw new Error(errorMessage)
50 }
51
52 // Trust our proxy (IP forwarding...)
53 app.set('trust proxy', CONFIG.TRUST_PROXY)
54
55 // Security middleware
56 import { baseCSP } from './server/middlewares'
57
58 app.use(baseCSP)
59 app.use(helmet({
60   frameguard: {
61     action: 'deny' // we only allow it for /videos/embed, see server/controllers/client.ts
62   },
63   hsts: false
64 }))
65
66 // ----------- Database -----------
67
68 // Initialize database and models
69 import { initDatabaseModels } from './server/initializers/database'
70 import { migrate } from './server/initializers/migrator'
71 migrate()
72   .then(() => initDatabaseModels(false))
73   .then(() => startApplication())
74   .catch(err => {
75     logger.error('Cannot start application.', { err })
76     process.exit(-1)
77   })
78
79 // ----------- PeerTube modules -----------
80 import { installApplication } from './server/initializers'
81 import { Emailer } from './server/lib/emailer'
82 import { JobQueue } from './server/lib/job-queue'
83 import { VideosPreviewCache, VideosCaptionCache } from './server/lib/cache'
84 import {
85   activityPubRouter,
86   apiRouter,
87   clientsRouter,
88   feedsRouter,
89   staticRouter,
90   servicesRouter,
91   webfingerRouter,
92   trackerRouter,
93   createWebsocketTrackerServer, botsRouter
94 } from './server/controllers'
95 import { advertiseDoNotTrack } from './server/middlewares/dnt'
96 import { Redis } from './server/lib/redis'
97 import { ActorFollowScheduler } from './server/lib/schedulers/actor-follow-scheduler'
98 import { RemoveOldJobsScheduler } from './server/lib/schedulers/remove-old-jobs-scheduler'
99 import { UpdateVideosScheduler } from './server/lib/schedulers/update-videos-scheduler'
100 import { YoutubeDlUpdateScheduler } from './server/lib/schedulers/youtube-dl-update-scheduler'
101 import { VideosRedundancyScheduler } from './server/lib/schedulers/videos-redundancy-scheduler'
102 import { isHTTPSignatureDigestValid } from './server/helpers/peertube-crypto'
103 import { PeerTubeSocket } from './server/lib/peertube-socket'
104
105 // ----------- Command line -----------
106
107 cli
108   .option('--no-client', 'Start PeerTube without client interface')
109   .parse(process.argv)
110
111 // ----------- App -----------
112
113 // Enable CORS for develop
114 if (isTestInstance()) {
115   app.use(cors({
116     origin: '*',
117     exposedHeaders: 'Retry-After',
118     credentials: true
119   }))
120 }
121 // For the logger
122 morgan.token('remote-addr', req => {
123   return (req.get('DNT') === '1') ?
124     anonymize(req.ip || (req.connection && req.connection.remoteAddress) || undefined,
125     16, // bitmask for IPv4
126     16  // bitmask for IPv6
127     ) :
128     req.ip
129 })
130 morgan.token('user-agent', req => (req.get('DNT') === '1') ?
131   useragent.parse(req.get('user-agent')).family : req.get('user-agent'))
132 app.use(morgan('combined', {
133   stream: { write: logger.info.bind(logger) }
134 }))
135 // For body requests
136 app.use(bodyParser.urlencoded({ extended: false }))
137 app.use(bodyParser.json({
138   type: [ 'application/json', 'application/*+json' ],
139   limit: '500kb',
140   verify: (req: express.Request, _, buf: Buffer) => {
141     const valid = isHTTPSignatureDigestValid(buf, req)
142     if (valid !== true) throw new Error('Invalid digest')
143   }
144 }))
145 // Cookies
146 app.use(cookieParser())
147 // W3C DNT Tracking Status
148 app.use(advertiseDoNotTrack)
149
150 // ----------- Views, routes and static files -----------
151
152 // API
153 const apiRoute = '/api/' + API_VERSION
154 app.use(apiRoute, apiRouter)
155
156 // Services (oembed...)
157 app.use('/services', servicesRouter)
158
159 app.use('/', activityPubRouter)
160 app.use('/', feedsRouter)
161 app.use('/', webfingerRouter)
162 app.use('/', trackerRouter)
163 app.use('/', botsRouter)
164
165 // Static files
166 app.use('/', staticRouter)
167
168 // Client files, last valid routes!
169 if (cli.client) app.use('/', clientsRouter)
170
171 // ----------- Errors -----------
172
173 // Catch 404 and forward to error handler
174 app.use(function (req, res, next) {
175   const err = new Error('Not Found')
176   err['status'] = 404
177   next(err)
178 })
179
180 app.use(function (err, req, res, next) {
181   let error = 'Unknown error.'
182   if (err) {
183     error = err.stack || err.message || err
184   }
185
186   // Sequelize error
187   const sql = err.parent ? err.parent.sql : undefined
188
189   logger.error('Error in controller.', { err: error, sql })
190   return res.status(err.status || 500).end()
191 })
192
193 const server = createWebsocketTrackerServer(app)
194
195 // ----------- Run -----------
196
197 async function startApplication () {
198   const port = CONFIG.LISTEN.PORT
199   const hostname = CONFIG.LISTEN.HOSTNAME
200
201   await installApplication()
202
203   // Check activity pub urls are valid
204   checkActivityPubUrls()
205     .catch(err => {
206       logger.error('Error in ActivityPub URLs checker.', { err })
207       process.exit(-1)
208     })
209
210   // Email initialization
211   Emailer.Instance.init()
212
213   await Promise.all([
214     Emailer.Instance.checkConnectionOrDie(),
215     JobQueue.Instance.init()
216   ])
217
218   // Caches initializations
219   VideosPreviewCache.Instance.init(CONFIG.CACHE.PREVIEWS.SIZE, CACHE.PREVIEWS.MAX_AGE)
220   VideosCaptionCache.Instance.init(CONFIG.CACHE.VIDEO_CAPTIONS.SIZE, CACHE.VIDEO_CAPTIONS.MAX_AGE)
221
222   // Enable Schedulers
223   ActorFollowScheduler.Instance.enable()
224   RemoveOldJobsScheduler.Instance.enable()
225   UpdateVideosScheduler.Instance.enable()
226   YoutubeDlUpdateScheduler.Instance.enable()
227   VideosRedundancyScheduler.Instance.enable()
228
229   // Redis initialization
230   Redis.Instance.init()
231
232   PeerTubeSocket.Instance.init(server)
233
234   // Make server listening
235   server.listen(port, hostname, () => {
236     logger.info('Server listening on %s:%d', hostname, port)
237     logger.info('Web server: %s', CONFIG.WEBSERVER.URL)
238   })
239
240   process.on('exit', () => {
241     JobQueue.Instance.terminate()
242   })
243
244   process.on('SIGINT', () => process.exit(0))
245 }