@wpengine/atlas-next

Atlas Next

Package that provides improved Next.js support on WP Engine Headless Platform.

Prerequisites

See our Node.js documentation for supported versions of Node.js on Headless Platform

The Atlas Next package versions:

• >=3.0.0 require a minimum Next.js version of v15.2.1
• >=2.0.0 <3.0.0 require a minimum Next.js version of v15.0.0 and a maximum lower than v15.2.1
• <2.0.0 require a minimum Next.js version of v12.2.0 and a maximum lower than v15.0.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:

for Next.js versions >= 15.2.1

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

for Next.js versions >= 15.0.0 < 15.2.1

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

for Next.js versions < 15.0.0

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

Usage

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

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

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

module.exports = withWPEConfig(nextConfig)

API

withWPEConfig

withWPEConfig(nextConfig: NextConfig, wpeConfig?: WPEConfig): NextConfig

Options

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

wpeConfig: 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 = withWPEConfig(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