@junobuild/nextjs-plugin NPM

Juno Next.js Plugin

A Next.js plugin for Juno.

Getting started

The plugin automatically loads your Satellite and Orbiter IDs.

With these values, you can instantiate Juno in your code without the need to manually define environment variables.

await Promise.all([initSatellite(), initOrbiter()]);

Environment variables

Those following environment variables are injected by this plugin:

Environment variable	Value in mode `development`	Value for other modes
NEXT_PUBLIC_SATELLITE_ID	`jx5yt-yyaaa-aaaal-abzbq-cai`	The Satellite ID for the `mode` from your Juno configuration file.
NEXT_PUBLIC_ORBITER_ID	`undefined`	The Orbiter ID from your Juno configuration file.
NEXT_PUBLIC_INTERNET_IDENTITY_ID	`rdmx6-jaaaa-aaaaa-aaadq-cai`	`rdmx6-jaaaa-aaaaa-aaadq-cai`
NEXT_PUBLIC_ICP_LEDGER_ID	`ryjl3-tyaaa-aaaaa-aaaba-cai`	`ryjl3-tyaaa-aaaaa-aaaba-cai`
NEXT_PUBLIC_ICP_INDEX_ID	`qhbym-qaaaa-aaaaa-aaafq-cai`	`qhbym-qaaaa-aaaaa-aaafq-cai`
NEXT_PUBLIC_NNS_GOVERNANCE_ID	`rrkah-fqaaa-aaaaa-aaaaq-cai`	`rrkah-fqaaa-aaaaa-aaaaq-cai`
NEXT_PUBLIC_CMC_ID	`rkp4c-7iaaa-aaaaa-aaaca-cai`	`rkp4c-7iaaa-aaaaa-aaaca-cai`

Variables prefixed with NEXT_PUBLIC_ are clearly marked for browser availability, but they are injected into the environment (documentation) by the plugin. If you prefer to remove or change this prefix, it is possible using the option prefix.

Installation

npm i @junobuild/nextjs-plugin -D

Usage

In your next.config.mjs file:

import {withJuno} from '@junobuild/nextjs-plugin';

export default withJuno();

The plugin sets the build output to export by default. You can override the option or provide additional options as follows:

import {withJuno} from '@junobuild/nextjs-plugin';

/** @type {import('next').NextConfig} */
const nextConfig = {
  output: 'export'
};

export default withJuno({nextConfig});

Options

The plugin can be customized using the optional juno configuration object. This allows you to control how the Juno Docker container is used in your project, especially during local development or end-to-end (E2E) testing.

`juno.container`

Use the container option to enable, disable, or fine-tune the use of Juno Docker.

You can provide:

false — to disable the container entirely.
true — to enable the container with default settings (only in development mode), which is also the default behavior.
An object with the following fields:
- url (string, optional): A custom container URL, including the port. Example: http://127.0.0.1:8000
- modes (string[], optional): An array of modes (e.g., 'development', 'test') during which the container should be used.

By default, the container is mounted only in development mode.

import {withJuno} from '@junobuild/nextjs-plugin';

/** @type {import('next').NextConfig} */
const nextConfig = {
  output: 'export'
};

export default withJuno({
  nextConfig,
  juno: {
    container: {
      url: 'http://127.0.0.1:8000',
      modes: ['development', 'test']
    }
  }
});