Terminating SSL

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 apollo-server-express middleware library.

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

index.ts

1
import express from 'express';
2
import { ApolloServer } from 'apollo-server-express';
3
import { ApolloServerPluginLandingPageLocalDefault } from 'apollo-server-core';
4
import typeDefs from './graphql/schema';
5
import resolvers from './graphql/resolvers';
6
import fs from 'fs';
7
import https from 'https';
8
import http from 'http';
9

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

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

20
  const server = new ApolloServer({
21
    typeDefs,
22
    resolvers,
23
    csrfPrevention: true,
24
    cache: 'bounded',
25
    plugins: [ApolloServerPluginLandingPageLocalDefault({ embed: true })],
26
  });
27
  await server.start();
28

29
  const app = express();
30
  server.applyMiddleware({ app });
31

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

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

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

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

53
  return { server, app };
54
}

index.js

1
import express from 'express';
2
import { ApolloServer } from 'apollo-server-express';
3
import { ApolloServerPluginLandingPageLocalDefault } from 'apollo-server-core';
4
import typeDefs from './graphql/schema';
5
import resolvers from './graphql/resolvers';
6
import fs from 'fs';
7
import https from 'https';
8
import http from 'http';
9

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

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

20
  const server = new ApolloServer({
21
    typeDefs,
22
    resolvers,
23
    csrfPrevention: true,
24
    cache: 'bounded',
25
    plugins: [ApolloServerPluginLandingPageLocalDefault({ embed: true })],
26
  });
27
  await server.start();
28

29
  const app = express();
30
  server.applyMiddleware({ app });
31

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

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

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

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

53
  return { server, app };
54
}

CORS

Proxy configuration