Terminating SSL

ⓘ NOTE

In the examples below, we use top-level await calls to start our server asynchronously. If you'd like to see how we set this up, check out the Getting Started guide for details.

Most production environments use a load balancer or HTTP proxy (such as nginx) to perform SSL termination on behalf of web applications in that environment.

If you're using Apollo Server in an application that must perform its own SSL termination, you can use the https module with the expressMiddleware function.

Here's an example that uses HTTPS in production and HTTP in development:

index.ts

1
import { ApolloServer } from '@apollo/server';
2
import { expressMiddleware } from '@apollo/server/express4';
3
import { ApolloServerPluginDrainHttpServer } from '@apollo/server/plugin/drainHttpServer';
4
import typeDefs from './graphql/schema';
5
import resolvers from './graphql/resolvers';
6
import cors from 'cors';
7
import express from 'express';
8
import http from 'http';
9
import https from 'https';
10
import fs from 'fs';
11

12
const configurations = {
13
  // Note: You may need sudo to run on port 443
14
  production: { ssl: true, port: 443, hostname: 'example.com' },
15
  development: { ssl: false, port: 4000, hostname: 'localhost' },
16
};
17

18
const environment = process.env.NODE_ENV || 'production';
19
const config = configurations[environment];
20

21
const server = new ApolloServer({
22
  typeDefs,
23
  resolvers,
24
});
25
await server.start();
26

27
const app = express();
28
// our express server is mounted at /graphql
29
app.use('/graphql', cors<cors.CorsRequest>(), express.json(), expressMiddleware(server));
30

31
// Create the HTTPS or HTTP server, per configuration
32
let httpServer;
33
if (config.ssl) {
34
  // Assumes certificates are in a .ssl folder off of the package root.
35
  // Make sure these files are secured.
36
  httpServer = https.createServer(
37
    {
38
      key: fs.readFileSync(`./ssl/${environment}/server.key`),
39
      cert: fs.readFileSync(`./ssl/${environment}/server.crt`),
40
    },
41

42
    app,
43
  );
44
} else {
45
  httpServer = http.createServer(app);
46
}
47

48
await new Promise<void>((resolve) => httpServer.listen({ port: config.port }, resolve));
49

50
console.log('🚀 Server ready at', `http${config.ssl ? 's' : ''}://${config.hostname}:${config.port}/graphql`);

index.js

1
import { ApolloServer } from '@apollo/server';
2
import { expressMiddleware } from '@apollo/server/express4';
3

4
import typeDefs from './graphql/schema';
5
import resolvers from './graphql/resolvers';
6
import cors from 'cors';
7
import express from 'express';
8
import http from 'http';
9
import https from 'https';
10
import fs from 'fs';
11

12
const configurations = {
13
  // Note: You may need sudo to run on port 443
14
  production: { ssl: true, port: 443, hostname: 'example.com' },
15
  development: { ssl: false, port: 4000, hostname: 'localhost' },
16
};
17

18
const environment = process.env.NODE_ENV || 'production';
19
const config = configurations[environment];
20

21
const server = new ApolloServer({
22
  typeDefs,
23
  resolvers,
24
});
25
await server.start();
26

27
const app = express();
28
// our express server is mounted at /graphql
29
app.use('/graphql', cors(), express.json(), expressMiddleware(server));
30

31
// Create the HTTPS or HTTP server, per configuration
32
let httpServer;
33
if (config.ssl) {
34
  // Assumes certificates are in a .ssl folder off of the package root.
35
  // Make sure these files are secured.
36
  httpServer = https.createServer(
37
    {
38
      key: fs.readFileSync(`./ssl/${environment}/server.key`),
39
      cert: fs.readFileSync(`./ssl/${environment}/server.crt`),
40
    },
41

42
    app,
43
  );
44
} else {
45
  httpServer = http.createServer(app);
46
}
47

48
await new Promise((resolve) => httpServer.listen({ port: config.port }, resolve));
49

50
console.log('🚀 Server ready at', `http${config.ssl ? 's' : ''}://${config.hostname}:${config.port}/graphql`);

CORS

Proxy configuration