Zimbra Administration Guide

This repository contains the code necessary to build the Zimbra Administration Guide.

This guide is for system administrators responsible for installing, maintaining, and supporting the server deployment of Zimbra.

Building the Documentation

The Zimbra Administration Guide is written using AsciiDoc. Specifically, it is intended to be processed with Asciidoctor.

As a prerequisite to building the documentation, you will need to have already installed and configured Asciidoctor. Check the Installation Quick Start in the Asciidoctor User Manual for information on how to get started.

Once you have Asciidoctor installed and working, you can build the documentation into HTML files like so:

asciidoctor -b html5 -D ~/temp/8.8.15 -o index.html index.adoc

PDF output can be generated as well:

asciidoctor-pdf -a allow-uri-read -D ~/temp/8.8.15 -o adminguide.pdf index.adoc

This assumes you have a "temp" directory to receive the asciidoctor output, and are generating output for version 8.8.15…​ adjust according to your situation. Each section of the document is contained in its own file. You may use the index.adoc file to generate the entire document.

To accompany the HTML output, the images/ folder must also be copied to the output destination:

cp -r ./images ~/temp/8.8.15/images

When publishing the output (gh-pages branch) the "latest" link needs to be updated to point at the new version:

ln -nsf 8.8.15 latest

Additional Information

Visit www.zimbra.com to join the community and to be a part of building the best open source messaging solution. We appreciate your feedback and suggestions.

Join the Zimbra Forums, to participate and learn more about Zimbra.

For additional product information check the Zimbra Wiki.

License

Synacor, Inc., 2019

© 2016-2019 by Synacor, Inc.

This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License unless another license agreement between you and Synacor, Inc. provides otherwise. To view a copy of this license, visit https://creativecommons.org/licenses/by-sa/4.0 or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.

Synacor, Inc.
40 La Riviere Drive, Suite 300
Buffalo, New York 14202

https://www.synacor.com