This guide shows you how to deploy an Gatsby application on Layer0:

This framework has a connector developed for Layer0. See Connectors for more information.

Layer0 only supports Node.js version 14 and higher

If you do not have Node.js installed on your system, download and install it from the official Node.js v14.x downloads page. Select the download that matches your operating system and run the installer. Note that the installer for Node.js will also install npm.

Note that while you can use any version of Node.js >= 14 locally, your app will run in Node 14 when deployed to the Layer0 cloud. Therefore we highly suggest using Node 14 for all development.

If you don't already have a Gatsby application, you can create one using:

npm install -g gatsby-cli
gatsby new gatsby-site

You should now have a working Gatsby site. Run gatsby develop to see the application running on localhost:8000.

To deploy your Gatsby on Layer0:

  1. Install the Layer0 CLI globally:
npm install -g @layer0/cli
  1. Run the following in the root folder of your project. This will configure your project for Layer0.
layer0 init

This will automatically add all of the required dependencies and files to your project. These include:

  • The @layer0/core package
  • The @layer0/gatsby package
  • The @layer0/cli package
  • layer0.config.js
  • routes.js - A default routes file that sends all requests to your Gatsby static site. Update this file to add caching or proxy some URLs to a different origin.

You can test the integration of the Layer0 router with your gatsby site locally using:

layer0 dev

Deploying requires an account on Layer0. Sign up here for free. Once you have an account, you can deploy to Layer0 by running the following in the root folder of your project:

layer0 deploy

See Deploying guide for more information.

The default routes.js file created by layer0 init sends all requests to the Gatsby static site.

// This file was automatically added by layer0 deploy.
// You should commit this file to source control.

const { Router } = require('@layer0/core/router')
const { gatsbyRoutes } = require('@layer0/gatsby')

module.exports = new Router().use(gatsbyRoutes)

To proxy some URLs to a different origin, you need first to configure that origin in your layer0.config.js file.

For example:

// layer0.config.js

module.exports = {
  backends: {
    legacy: {
      domainOrIp: process.env.LEGACY_BACKEND_DOMAIN || '',
      hostHeader: process.env.LEGACY_BACKEND_HOST_HEADER || '',

Using environment variables here allows you to configure different legacy domains for each Layer0 environment.

Then you can add routing and caching rules to your routes.js file. Note that gatsbyRoute must be declared last as it acts as a fallback route.

For example:

// routes.js

const { Router } = require('@layer0/core/router')
const { gatsbyRoutes } = require('@layer0/gatsby')

module.exports = new Router()
  .get('/some/legacy/url/:p', ({ proxy }) => {

Check Routing and Caching guides for more information.