Linux Requirements

On this page, you’ll learn:

  • How to install Node.

Since Antora is built on Node.js, you’ll need Node installed on your machine to install and run Antora.

Node

We recommend using the latest long term support (LTS) release of Node. While you can use other versions of Node, Antora is only tested against active LTS releases.

To see if you have Node installed, and which version, open a terminal and type:

$ node --version

You should see a version string, such as:

v12.16.2

If the command fails with an error, it means you don’t have Node installed. The best way to install Node is to use nvm (Node Version Manager). Skip to Install nvm and Node to find instructions.

If your package manager provides Node and npm packages, and you’re familiar with using the tools installed system-wide, you may choose to go that route. However, we believe you’ll be more successful if you choose nvm.

If the command returns a version that isn’t an active LTS version, upgrade to the latest Node LTS version using nvm (or your package manager).

If the command returns an active Node LTS version, make sure that version is set as your default version by typing the following command in your terminal:

$ nvm alias default 12

Now you’re ready to install Antora.

Install nvm and Node

We recommend using the Node Version Manager (nvm) to manage your Node installations. Follow these installation instructions to set up nvm on your machine. Then, return here.

Many CI environments use nvm to manage the version of Node used in the build job. By using nvm, you can align your setup with the environment used to generate and publish your production site.

Once you’ve installed nvm, open a new terminal and install the latest Node LTS release.

$ nvm install --lts

The above command will install the latest LTS release of Node and automatically set it as your default alias.

Now that you have Node set up, you can install Antora.

Upgrade Node using nvm

If you have nvm installed, but don’t have the latest LTS version installed, type the following command in your terminal:

$ nvm install --lts

To set the latest version of Node as the default for any new terminal, type:

$ nvm alias default 12

Now that you’re on the latest LTS version of Node, you can install Antora.