Atlas Next

Package that provides improved Next.js support on WP Engine Atlas.

Prerequisites

See our Node.js documentation for supported versions of Node.js on Atlas

The Atlas Next package requires a minimum Next.js version of v12.2.0

For On-Demand Revalidation support a minimum Next.js version of v13.5.1 is required

Next.js versions >= 13.4.13 < 13.5.1 are not supported due to a bug in Next.js.

Install

To install the package, run:

$ npm install --save @wpengine/atlas-next

Usage

In the next.config.(mjs|js) file at the root of your Next.js project wrap the exported nextConfig with the withAtlasConfig method:

const { withAtlasConfig } = require("@wpengine/atlas-next")

/** @type {import('next').NextConfig} */
const nextConfig = {
  // Your existing Next.js config
}

module.exports = withAtlasConfig(nextConfig)

API

withAtlasConfig

withAtlasConfig(nextConfig: NextConfig, atlasConfig?: AtlasConfig): NextConfig

Options

nextConfig: The existing nextConfig in the next.config.js file

atlasConfig: The following options can be set

| Name | Type | Description | Default value | | --- | --- | --- | --- | | remoteCacheHandler | boolean | Enable or disable the Remote Cache Handler | true |

For example:

module.exports = withAtlasConfig(nextConfig, { remoteCacheHandler: false })

Report an issue

To report security vulnerabilities please see https://wpengine.com/security/.

Bugs can be reported using the live chat in the User Portal

License

MIT License © WP Engine