How-to host or archive your own copy of the documentation

Owned by Anastasios Thomaidis
Last updated: Oct 31, 2024 by Matthew Hierholzer
There is no default way to download our official guide as a PDF file. We will show you one recommended way if you need the official guide as an offline PDF.

LAST TESTED ON CHECKMK 2.0.0P1

Table of Contents

Step-by-step guide

The source code of our official guide is stored at Github: https://github.com/Checkmk/checkmk-docs

You can use asciidoctor to convert the doc to PDF or HTML file


  1. Clone the repository: https://github.com/Checkmk/checkmk-docs

  2. Install asciidoctor: https://github.com/asciidoctor/asciidoctor

  3. Convert the files to PDF/HTML

.

 At the moment, this is the only recommended way. We're considering providing a zip file, including the HTML docs.

.

There is a second way using wget -m. This way is not recommended due to missing functionality like the broken search. 

Use wget to download the docs:

 wget -m https://docs.checkmk.com/latest/en/

Now you can use a web server to visualize the html files or convert the files to pdf