Public documentation

Click on SUMMARY to view a linked tree structure of the public documentation.

The public documentation is divided into the following main categories:

Release information gives release information of latest release.
Installation contains documents that explain how to install the different components of Zonemaster.
Upgrading contains documents that explain how to upgrade a Zonemaster installation.
Configuration contains documents that explain how a Zonemaster installation can be configured.
Using contains user guides to the different components of Zonemaster.
Specifications contains specifications of the Zonemaster test cases, test types and test zones.
Development contains information for developers both in and outside the Zonemaster project.
License gives the license information for Zonemaster.

Rendering

Renderings of the public documentation are published to doc.zonemaster.net for every release version since v2023.1. It can be built locally using mdbook, its mdbook-linkcheck plugin.

Get a copy of the source tree by cloning the repository or downloading an archive of one of the releases.
Change to the docs/public directory and build the book.

cd docs/public
mdbook build

To view the content there are a few options:

Open the index file if your OS has support for it:

open book/index.html

Let mdbook serve it on local computer. Run the following command and open localhost:3000 in your browser.

mdbook serve

Copy the book directory with all files to your computer, go directly to that directory and open book/index.html.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!