Windows Installation Requirements

On this page, you’ll learn:

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

  • How to install Node 8.

  • How to install Chocolatey, the Windows package manager.

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

To install Antora, you need Node 8 and Chocolatey.

Node 8

Antora requires Node 8, the current long term support (LTS) release of Node.

To check which version of Node you have installed, if any, open PowerShell and type:

$ node --version

If the command fails with an error, you don’t have Node installed. The best way to install Node 8 is via Chocolatey. If you don’t have Chocolatey on your machine, go to install Chocolatey, otherwise, skip directly to install nvm and Node for instructions.

If the command returns a version less than 8.0.0, upgrade to the latest Node 8 version using nvm. Go directly to upgrade Node for instructions.

If the command returns a Node 8 version, you’re ready to install Antora.

While you can use Node 9, we don’t recommend it because there are no precompiled binaries for Node 9 of nodegit, a dependency of Antora. If you use Node 9, installation will take considerably longer.

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

If you just installed Chocolatey using the instructions in the proceeding section, use the terminal, running as Administrator, you already have open.
  1. Open a PowerShell terminal, right click on the PowerShell icon, and select Run as Administrator.

  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 with nvm.

    $ nvm install 8.9.4
    When using nvm for Windows, you must enter the full version of Node (i.e., nvm install 8.9.4) 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 that is used to generate and publish your production site.

Upgrade Node with nvm

If you have nvm installed but your Node version is less than 8.0.0, type the following command in your terminal to install the latest version of Node 8:

$ nvm install 8.9.4
When using nvm for Windows, you must enter the full version of Node (i.e., nvm install 8.9.4) until nvm-windows#214 is resolved.

Now that you’ve upgraded Node, you’re ready to install Antora.

What’s next?

Once you’ve installed Node 8, it’s time to install Antora.