This guide shows you how to deploy a Nuxt.js application to Edgio. If you run into any issues please consult the Troubleshooting section.
Example SSR Site
This Nuxt.js example app uses server-side rendering and prefetching to provide lightening-fast transitions between pages.
Example ISG Site
This Nuxt.js example app uses ISG (Incremental Static Generation) to provide lightening-fast transitions between pages.
Prerequisites
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
1npm i -g @layer0/cli@latest
Creating a new Nuxt app
If you don’t already have a nuxt.js application, you can create one using:
Bash
1npm create nuxt-app my-nuxt-app
Nuxt’s create module will ask you a series of questions to configure your app. Make sure you answer as follows:
- For
Choose rendering mode
selectUniversal (SSR)
- Your answers to the other questions should not matter for the purposes of this guide.
Adding Edgio to an existing Nuxt app
To prepare your Nuxt.js application for Edgio:
- In the existing
nuxt.config.js
configuration, add “@layer0/nuxt/module” tobuildModules
:
JavaScript
1// nuxt.config.js23module.exports = {4 ...5 buildModules: [['@layer0/nuxt/module', { layer0SourceMaps: true }]],6 ...7}
Options:
layer0SourceMaps: true|false
: when true, the serverless build includes sourcemap files which make debugging easier when tailing the server logs in the Edgio Developer Console. It also increases the serverless bundle size, which may push your deployments over the 50MB (compressed) limit.
We noticed some performance issues related to sourcemaps being loaded in our Serverless infrastructure, which may result in 539 project timeout errors. In case you encounter such errors, please try again with sourcemaps disabled. This document will be updated once the problem is fully resolved.
- Run
0 init
to configure your project for Edgio.
Bash
10 init
The
0 init
command will automatically add all the required dependencies and files to your project. These include:- The
@layer0/core
package - The
@layer0/nuxt
package - The
@layer0/vue
package layer0.config.js
- Contains various configuration options for Edgio.routes.js
- A default routes file that sends all requests tonuxt.js
. You can update this file to add caching or proxy some URLs to a different origin as described later in this guide.sw/service-worker.js
- A service worker that provides static asset and API prefetching.
This command will also update your
package.json
with the following changes:- Moves all packages in
dependencies
todevDependencies
except those listed in themodules
property ofnuxt.config.js
. - Adds
@nuxt/core
todependencies
- Adds several
scripts
to run the available0
commands
As an example, here’s the original
package.json
from Nuxt’s create step:JSON
1{2 "name": "my-nuxt-app",3 "version": "1.0.0",4 "description": "My remarkable Nuxt.js project",5 "author": "Techy Ted",6 "private": true,7 "scripts": {8 "dev": "nuxt",9 "build": "nuxt build",10 "start": "nuxt start",11 "generate": "nuxt generate"12 },13 "dependencies": {14 "@layer0/cli": "^2.0.0",15 "@layer0/core": "^2.0.0",16 "@layer0/nuxt": "^2.0.0",17 "nuxt": "^2.0.0"18 },19 "devDependencies": {}20}
And here is the
package.json
after modifications by 0 init
:JSON
1{2 "name": "my-nuxt-app",3 "version": "1.0.0",4 "description": "My remarkable Nuxt.js project",5 "author": "Techy Ted",6 "private": true,7 "scripts": {8 "dev": "0 run",9 "build": "0 build",10 "start": "0 run",11 "prod": "0 run --production",12 "generate": "nuxt generate"13 },14 "dependencies": {15 "@nuxt/core": "^2.14.2"16 },17 "devDependencies": {18 "@layer0/cli": "^2.0.0",19 "@layer0/core": "^2.0.0",20 "@layer0/nuxt": "^2.0.0",21 "@layer0/vue": "^2.0.0",22 "dotenv": "^8.2.0",23 "nuxt": "^2.0.0",24 "serverless": "^1.64.0",25 "serverless-dotenv-plugin": "^2.3.2",26 "serverless-offline": "^5.14.1"27 }28}
Run the Nuxt.js app locally on Edgio
Run the Nuxt.js app with the command:
Bash
1npm run 0:dev
Load the site: http://127.0.0.1:3000
modules vs buildModules
Nuxt does not bundle packages listed in the
modules
property of nuxt.config.js
when building your app for production.
This can lead to an increased bundle size and slow down server-side rendering. Most Nuxt modules can be moved to
buildModules
. We recommend the following to maximize performance of server-side rendering in the cloud:- Move all entries from
modules
tobuildModules
innuxt.config.js
- Move all corresponding packages from
dependencies
todevDependencies
in package.json - Run
yarn install
ornpm install
to update your lock file.
Doing so will exclude these modules from your production deployment and keep the bundle size as small as possible.
Routing
The next few sections of this guide explain how Edgio interacts with Nuxt’s routing, which is important if you are migrating an existing application. If you just created a new nuxt app, you can jump to Running Locally and come back to these sections later.
Edgio supports Nuxt.js’s built-in routing scheme. The default
routes.js
file created by 0 init
sends all requests to Nuxt.js via a fallback route:JavaScript
1// This file was automatically added by 0 deploy.2// You should commit this file to source control.3const { Router } = require('@layer0/core/router')4const { nuxtRoutes, renderNuxtPage } = require('@layer0/nuxt')56module.exports = new Router()7 // Prevent search engine bot(s) from indexing8 // Read more on: https://docs.layer0.co/applications/cookbook#blocking-search-engine-crawlers9 .noIndexPermalink()10 .use(nuxtRoutes)
nuxtRoutes Middleware
In the code above,
nuxtRoutes
adds all Nuxt.js routes based on the /pages
directory. It’s also compatible with extending Nuxt’s router via the router
config in nuxt.config.js
, for example:JavaScript
1// nuxt.config.js2export default {3 // ... more config ...4 router: {5 // For example, we can extend the nuxt router to accept /products in addition to /p.6 // The nuxtRoutes middleware automatically picks this up and adds it to the Edgio router7 extendRoutes(routes, resolve) {8 routes.push({9 path: '/products/:id?',10 component: resolve(__dirname, 'pages/p/_id.vue'),11 })12 },13 },14 // ... more config ...15}
You can add additional routes before and after
nuxtRoutes
, for example to send some URLs to an alternate backend. This is useful for gradually replacing an existing site with a new Nuxt.js app.A popular use case is to fallback to a legacy site for any route that your Nuxt.js app isn’t configured to handle:
JavaScript
1new Router().use(nuxtRoutes).fallback(({ proxy }) => proxy('legacy'))
To configure the legacy backend, use layer0.config.js:
JavaScript
1module.exports = {2 backends: {3 legacy: {4 domainOrIp: process.env.LEGACY_BACKEND_DOMAIN || 'legacy.my-site.com',5 hostHeader: process.env.LEGACY_BACKEND_HOST_HEADER || 'legacy.my-site.com',6 },7 },8}
Using environment variables here allows you to configure different legacy domains for each Edgio environment.
Caching
The easiest way to add edge caching to your nuxt.js app is to add caching routes before the middleware. For example,
imagine you have
/pages/c/_categoryId.js
:JavaScript
1new Router()2 .get('/pages/c/:categoryId', ({ cache }) => {3 cache({4 browser: {5 maxAgeSeconds: 0,6 serviceWorkerSeconds: 60 * 60 * 24,7 },8 edge: {9 maxAgeSeconds: 60 * 60 * 24,10 staleWhileRevalidateSeconds: 60 * 60,11 },12 })13 })14 .use(nuxtMiddleware)
Prefetching
The
@layer0/nuxt/module
builds a service worker that enables prefetching using Edgio and injects it into your app’s browser code. The service worker is based on Google’s Workbox library. The entry point for the service worker source code is sw/service-worker.js
. If your app has an existing service worker that uses workbox, you can copy its contents into sw/service-worker.js
and simply add the following to your service worker:JavaScript
1import { Prefetcher } from '@layer0/prefetch/sw'2new Prefetcher().route()
The above allows you to prefetch pages from Performance’s cache to greatly improve browsing speed. To prefetch a page, add the
Prefetch
component from @layer0/vue
to any router-link
or nuxt-link
element:JavaScript
1<template>2 <ul v-for="product in products">3 <li>4 <Prefetch v-bind:url="'/api/' + product.url">5 <nuxt-link v-bind:to="product.url">6 <img v-bind:src="product.thumbnail" />7 </nuxt-link>8 </Prefetch>9 </li>10 </ul>11</template>12<script>13 import { Prefetch } from '@layer0/vue'14 export default {15 components: {16 Prefetch,17 },18 }19</script>
The
Prefetch
component fetches data for the linked page from Performance’s cache based on the url
property and adds it to the service worker’s cache when the link becomes visible in the viewport. When the user taps on the link, the page transition will be instantaneous because the browser won’t need to fetch data from the network.Serving Sitemap with SSR
You can configure Nuxt to generate a sitemap in SSR mode with the following configuration:
JavaScript
1export default {2 ...34 // Modules: https://go.nuxtjs.dev/config-modules5 modules: [6 '@nuxtjs/sitemap',7 ],89 sitemap: {10 hostname: 'yourhost.com',11 path: '/sitemap.xml',12 defaults: {13 lastmod: new Date(),14 changefreq: 'weekly',15 priority: 0.8,16 },17 },18}
Within the Edgio router, add the following:
JavaScript
1new Router()2...34.match('/sitemap.xml', ({ renderWithApp }) => {5 renderWithApp()6})7.use(nuxtMiddleware)
This will send all traffic for
/sitemap.xml
to Nuxt middleware for server-side rendering.Static Sites
Edgio supports fully and partially static sites using Nuxt generate. To deploy a static Nuxt site on Edgio, simply set
target: 'static'
in nuxt.config.js
and run 0 deploy
. This will run nuxt build
and nuxt generate
to generate a static version of your site.Incremental Static Rendering (ISG)
By default, requests for any pages that are not statically rendered at build time will fall back to server side rendering. If you use the Edgio router to cache pages that are not statically rendered, the first user who attempts to access the page will see the fallback HTML page generated by Nuxt (200.html by default). Edgio will render and cache the HTML in the background so that subsequent visits result in a full HTML response. This behavior is similar to Next.js incremental static rendering (ISG). Here is an example route that adds caching for a partially static page:
JavaScript
1import { Router } from '@layer0/core/router'2import { nuxtRoutes } from '@layer0/nuxt'34export default new Router()5 .get('/products/:id', ({ cache }) => {6 cache({7 edge: {8 // Requests for product pages that are not statically generated will fall back to SSR.9 // The first user will see the 200.html loading page generated by Nuxt.10 // Edgio will render full HTML response in the background and cache it for one hour at the edge.11 // All future requests to the page will result in the full HTML response.12 maxAgeSeconds: 60 * 60 * 24,13 staleWhileRevalidateSeconds: 60 * 60, // continue to serve stale responses from the edge cache while refreshing via SSR in the background14 },15 })16 })17 .use(nuxtRoutes)
Rendering a 404 Page
If you set the
fallback
property in the generate config to true
, Nuxt.js will generate a 404.html page that will be served whenever the URL does not match a static page. Edgio will send a 404 http status for these URLs. Note that if you set the fallback property to a string, Nuxt will generate a fallback page with that name, and Edgio will serve it with a 200 http status when the URL does not match a statically generated page.includeFiles
Nuxt requires that certain resources are included in a build and deploy to have access to them. As such, at times this will require additional configuration. To include additional resources for server side rendering, API calls, etc., use the
includeFiles
option in your layer0.config.js
file. Read moreIn this example, we would have an
api
folder that we want to include all items from.JavaScript
1includeFiles: {2 'api/**/*': true,3},
In addition, if
includeNodeModules
does not copy over the necessary package that may be needed in production, it can be included via this key as well. For instance,JavaScript
1includeFiles: {2 'node_modules/some_package/**/*': true,3}
Nitro
The Nuxt team provides a renderer called Nitro which optimizes your application for serverless deployment and greatly minimizes the size of your server application bundle. If you’re running into the size limitation for serverless bundles (50MB), you might try adding Nitro to your app. As of June 2021 Nitro is still not production ready, so use at your own risk.
Edgio provides a connector specifically for Nuxt apps that use nitro called
@layer0/nuxt-nitro
.To add Nitro to your app, make the following changes:
- Install nitro and the connector as dev dependencies:
Bash
1npm install -D @nuxt/nitro @layer0/nuxt-nitro`
- Ensure
buildModules
in nuxt.config.js contains the following:
JavaScript
1buildModules: [2 '@nuxt/nitro/compat',3 '@layer0/nuxt-nitro/module', // If you have previously added @layer0/nuxt/module you can remove it.4 // ...others...5 ],
- Add the following to nuxt.config.js:
JavaScript
1publicRuntimeConfig: {2 nitroVersion: require('@nuxt/nitro/package.json').version,3 },
-
If your nuxt.config.js has a
target
property, remove it. -
If you’ve previously added
@layer0/nuxt
as a dependency, you can remove it.
Additional Nitro Resources
Running Locally
Test your app with Sites on your local machine by running the following command in your project’s root directory:
Bash
10 build && 0 run
You can do a production build of your app and test it locally using:
Bash
10 build && 0 run --production
Setting
--production
runs your app exactly as it will be uploaded to the Edgio cloud using serverless-offline.Deploying
Deploy your app to the Sites by running the following command in your project’s root directory:
Bash
10 deploy
See deploying for more information.
Troubleshooting
The following section describes common gotchas and their workarounds.
I get an error message Nuxt.js Internal Server Error
This may be because you have a custom server framework (such as Express). Please make sure you selected
None
when asked to choose Choose custom server framework
during the creation of your nuxt app.0 init doesn’t work
If you get a command not found error such as:
Bash
10 init2- bash: 0: command not found
Make sure you installed the Edgio CLI
Bash
1npm i -g @layer0/cli
Make sure your version of the Edgio CLI is current
If you previously installed the Edgio CLI, make sure your version is current.
Check npm for the latest released version of the CLI:
Bash
1npm show @layer0/cli version21.16.2
Compare the latest release against the version currently installed on your system:
Bash
10 --version21.16.2
If your version is out of date you can update it by running
Bash
1npm update -g @layer0/cli
Error on deploy: layer0-deploy-lambda: Unzipped size must be smaller than...
As the error states, there is an upper limit on how big a package can be when deployed to our serverless infrastructure. Some common strategies for solving:
- You may need to move some dependencies as described here. Only dependencies are copied up to the lambda.
- Make sure you are using imports in a smart way. A common example is changing:
import { get } from lodash
toimport get from lodash/get
to avoid unnecessary bloat in your modules
You can view what is included in your package under
.layer0/lambda/
after a build, and running du -h -d 1
on the directories in a shell will output the size of each directory and help you identify where space savings can be found, ie du -h -d 1 .layer0/lambda/.nuxt