Windows Installation Requirements

On this page, you’ll learn:

  • What tools you need in order to install Antora on Windows.

  • How to install Chocolatey, the Windows package manager.

  • How to install Node.

If you’ve never installed Antora before, you’ll need to complete the steps on this page before you can install Antora and use it to generate a documentation site.

Antora is built on Node.js (“Node”). To install Antora, all you need on your machine is a long term support (LTS) release of Node. We’ll be using the Chocolatey package manager to install it.

Node

You need Node installed on your machine to install and run Antora. Antora follows Node’s release schedule, so we advise that you choose an active long term support (LTS) release of Node. We recommend using the latest active Node LTS version. While you can use other versions of Node, Antora is only tested against LTS releases.

To check whether you have Node installed, and which version, open PowerShell and type:

$ node --version

You should see a version string, such as:

v10.15.0

If the command fails with an error, you don’t have Node installed. The best way to install Node on Windows is to use Chocolatey. If you don’t have Chocolatey on your machine, go to install Chocolatey to get it set up. Otherwise, skip directly to install nvm and Node.

If the command returns a version that isn’t an active LTS version, upgrade to the latest Node LTS version using nvm.

If the command returns an active Node LTS version, you’re all set to install Antora.

Install Chocolatey

The best way to install the Node Version Manager (nvm) and Node is with Chocolatey, the package manager for Windows.

  1. Open a PowerShell terminal and run it as an Administrator by right clicking on the PowerShell icon and selecting Run as Administrator.

  2. Type the following command in the terminal:

    $ Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))

You’re now ready to install nvm and Node.

Install nvm and Node

  1. Open a PowerShell terminal, right click on the PowerShell icon, and select Run as Administrator.

    If you just installed Chocolatey using the instructions in the proceeding section, use the same terminal (running as Administrator) that you already have open.

  2. To install the Node Version Manager (nvm) for Windows, enter the following command in the terminal:

    $ choco install -y nvm

  3. Close the terminal.

  4. Open an new, regular PowerShell terminal, and install Node using nvm.

    $ nvm install 10.15.0
    When using nvm for Windows, you must enter an exact version of Node (e.g., 10.15.0) until nvm-windows#214 is resolved.

Now that Node is installed, you’re ready to install Antora.

nvm and CI environments

You can install the LTS release of Node directly, without installing nvm, by entering the following command in the Administrator PowerShell:

$ choco install -y nodejs-lts

However, many CI environments use nvm to install the Node version used for the build job. By using nvm, you closely align your setup with the environment used to generate and publish your production site.

Upgrade Node using nvm

If you have nvm installed but your Node version is not an LTS release, type the following command in your terminal:

$ nvm install 10.15.0
When using nvm for Windows, you must enter the full version of Node (i.e., nvm install 10.15.0).

Next

Once you’ve installed Node, you’re ready to install Antora.