Remix

This guide shows you how to deploy a Remix application to Edgio.

Deploying requires an account on Edgio. Sign up here for free.

Install the Edgio CLI

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

Bash
npm i -g @edgio/cli

Create a new Remix app

If you don’t already have a Remix app, create one by running the following:

Bash
npx create-remix@latest
# Choose express server
cd project-name

You can verify your app works by running it locally with:

1npm run dev

Configuring your Remix app for Edgio

Initialize your project

In the root directory of your project run edgio init:

1edgio init

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

The @edgio/core package - Allows you to declare routes and deploy your application on Edgio
The @edgio/prefetch package - Allows you to configure a service worker to prefetch and cache pages to improve browsing speed
edgio.config.js - A configuration file for Edgio
routes.js - A default routes file that sends all requests to Remix.

Install @edgio/express

Install @edgio/express by running the following:

Bash
npm install @edgio/express

Update Edgio Configuration

Update edgio.config.js at the root of your project to the following:

JavaScript
// This file was automatically added by edgio deploy.
// You should commit this file to source control.
module.exports = {
  connector: '@edgio/express',
  express: {
    appPath: './server/index.js',
  },
  includeFiles: {
    public: true,
  },
}

Configure the routes

Update routes.js at the root of your project to the following:

JavaScript
// This file was added by edgio init.
// You should commit this file to source control.
const ONE_HOUR = 60 * 60
const ONE_DAY = 24 * ONE_HOUR

const { Router } = require('@@edgio/core/router')

module.exports = new Router()
  .match('/', ({ cache }) => {
    cache({
      edge: {
        maxAgeSeconds: ONE_DAY,
      },
      browser: false,
    })
  })
  .match('/example-path', ({ cache }) => {
    // other paths
    cache({
      edge: {
        maxAgeSeconds: ONE_DAY,
      },
      browser: false,
    })
  })
  .match('/build/:path*', ({ cache }) => {
    // route build output files through Edgio
    cache({
      edge: {
        maxAgeSeconds: ONE_DAY,
        forcePrivateCaching: true,
      },
      browser: {
        maxAgeSeconds: 0,
        serviceWorkerSeconds: ONE_DAY,
      },
    })
  })
  .fallback(({ renderWithApp }) => renderWithApp())

Refer to the CDN-as-code guide for the full syntax of the routes.js file and how to configure it for your use case.

Run the Remix app locally on Edgio

Create a production build of your app by running the following in your project’s root directory:

1npm run build

Run Edgio on your local machine:

1edgio run --production

Load the site http://127.0.0.1:3000

Deploying