gatsbyjs/gatsby-docker

gatsbyjs/gatsby-docker

Docker image that builds and hosts a Gatsby site.

Note: this is a community maintained project and doesn't yet have support for Gatsby v3 and beyond features like Functions, SSR, and DSG

This image has two major tags:

1. latest - will serve your assets on production using up an nginx server

2. onbuild - builds your project and creates a new docker image

Usage

1. Create at the root of your project a Dockerfile and .dockerignore, as below: Dockerfile

   FROM gatsbyjs/gatsby:onbuild as build
   
   FROM gatsbyjs/gatsby
   COPY --from=build /app/public /pub
   

   .dockerignore

   .cache/
   node_modules/
   public/
   

   The first image is going to copy your project, install dependencies and build it.

2. Build your project's docker image:

   docker build -t myproject/website .
   

3. Upload to the registry

   docker push myproject/website
   

4. Use it

   docker run --rm -p 80:80 myproject/website
   # Open your browser at http://localhost
   

Configuration

The way Nginx behaves can be configured using environment variables.

Please refer to the docker run command options for the --env-file flag where you can specify all required environment variables in a single file. This will save you from writing a potentially long docker run command. Alternatively you can use docker-compose.

Below is the complete list of available options that can be used to customize your Nginx configuration:

Append rules for the server block in nginx config

You can mount a file to /etc/nginx/server.conf to extend the server block in nginx config. This could be useful if you have defined client-only routes in GatsbyJS. For example for client only rules on path /client-only the content of your mounted file should be like:

rewrite ^/client-only/([^.]*?/)$ /client-only/index.html;

Alternatively you can use a custom Dockerfile and copy the file on build:

FROM gatsbyjs/gatsby:latest
COPY nginx-server-rules.conf /etc/nginx/server.conf

NOTE: By adding the file /etc/nginx/server.conf, all the contents of the CUSTOM_SERVER_CONFIG environment variable will be discarded.