Supported Platforms and System Requirements

Antora runs on well-known Linux distributions, macOS, and Windows. Thanks to this broad platform support, Antora can be used with most continuous integration environments and cloud platforms.

This page provides an overview of the platforms Antora supports and directs you to the system requirements for each platform. The Antora project also provides an official Docker container you can use to bypass the installation process.

Platforms

Antora is actively tested on the platforms listed below.

Supported Platform Supported Version(s)

Alpine Linux

3.7
3.6

Debian

9.3

Fedora

27
26

macOS

High Sierra

Microsoft

Windows 10
Windows 8.1
Windows Server 2016
Windows Server 2012 R2

Chrome

Latest stable version

Firefox

Latest stable version

Internet Explorer

11

MS Edge

Latest stable version

Node

8 (latest release in line)

While we only continuously test Antora on Fedora, Alpine Linux, Debian, and Ubuntu, we anticipate it should operate as expected on most well-known Linux distributions.

About the Antora Test Suite

At last count, Antora had over 850 tests that cover over 99% of the lines. And we add more tests with every change. You could say we’re just a teeny bit obsessed with writing high quality tests and maintaining complete test coverage.

Cloud platforms

Antora should operate as designed on common cloud platforms. How you provision your cloud instance depends on your workload requirements and remote git repository sizes. If you’re running Antora on a cloud platform, we would love to hear about your experience (open a new issue or join us in the development channel).

Hardware recommendations

Your hardware requirements will depend primarily on the size of the remote git repositories your Antora pipeline fetches content from when it is generating your site.

The first time Antora runs, it fetches and clones all of the remote git repositories specified in a playbook. The speed of this operation is dictated by the size of the remote repositories, environment input/output parameters, and network performance. After the initial run, Antora caches the repositories locally. On subsequent runs, Antora only reconnects to the remote repositories if the pull option is enabled or the cache folder is removed.

RAM

Memory requirements depend on the size of your Git repositories. 3GB should provide performance headroom.

I/O

Maximum throughput and minimum latency always make things nicer but aren’t required.

What’s next?

Prep your system for installing Antora:

Or try out the official Antora Docker container.