Gatsby

This guide shows you how to deploy an Gatsby application to Edgio.

Setup requires:

An Edgio account. Sign up for free.
An Edgio property. Learn how to create a property.
Node.js. View supported versions and installation steps.
Edgio CLI.

Install the Edgio CLI

If you have not already done so, install the Edgio CLI.

Bash
npm i -g @layer0/cli@latest

Getting Started

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

Bash
npm install -g gatsby-cli
gatsby new gatsby-site https://github.com/gatsbyjs/gatsby-starter-hello-world

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

Configure your project for Edgio by running the following command in your project’s root directory:

10 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.

Running Locally

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

10 dev

Deploying

Deploy your app to the Sites by running the following command in your project’s root directory:

10 deploy

See Deploying guide for more information.

Routing

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

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

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

module.exports = new Router()
  // Prevent search engine bot(s) from indexing
  // Read more on: https://docs.layer0.co/applications/cookbook#blocking-search-engine-crawlers
  .noIndexPermalink()
  .use(gatsbyRoutes)

Adding routes to a different origin

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

For example:

JavaScript
// layer0.config.js

module.exports = {
  backends: {
    legacy: {
      domainOrIp: process.env.LEGACY_BACKEND_DOMAIN || 'legacy.my-site.com',
      hostHeader: process.env.LEGACY_BACKEND_HOST_HEADER || 'legacy.my-site.com',
    },
  },
}

Using environment variables here allows you to configure different legacy domains for each Edgio 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.