Zimbra / installguides

Zimbra Installation Guides

Zimbra Installation Guides

This repository contains the code necessary to build the Zimbra Installation Guides.

These guides are intended for system administrators responsible for installing, maintaining, and supporting the server deployment of Zimbra.

Important

8.8.15 and 9.0.0 documentation have their own branches to build documentation

Building the Documentation

The Zimbra Installation related guides are written using AsciiDoc. Specifically, they are 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, as in the following examples:

Zimbra Collaboration - Performing a Multi-Server Installation

Each section of each document is contained in its own file. You may use the multi-server-install.adoc file to generate the entire document.

HTML

asciidoctor -b html5 -o {version}/multi.html multi-server-install.adoc

PDF

asciidoctor-pdf -a allow-uri-read -o {version}/multi-server-install.pdf multi-server-install.adoc

Zimbra Collaboration - Performing a Single-Server Installation

Each section of each document is contained in its own file. You may use the index-single-server-install.adoc file to generate the entire document.

HTML

asciidoctor -b html5 -o {version}/single.html index-single-server-install.adoc

PDF

asciidoctor-pdf -a allow-uri-read -o {version}/single-server-install.pdf index-single-server-install.adoc

Zimbra Collaboration - Upgrade Guide

HTML

asciidoctor -b html5 -o {version}/upgrade.html upgrade.adoc

PDF

asciidoctor-pdf -o upgrade.pdf upgrade.adoc

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

ln -nsf {product-version} latest

Important

Windows users need to launch Command Prompt with administrator privileges and use the command mklink.

mklink /D latest {product-version}

Tip	The above command does not overwrite the existing symlink, hence first rename it.

Finally, the index.html file in the root folder needs to be updated to include appropriate links for the new version’s documents. Use your favorite text editor to complete this task before committing and pushing the updated gh-pages branch to the repo.

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., 2016-2017

© 2016-2018 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., 2016
40 La Riviere Drive, Suite 300
Buffalo, New York 14202

https://www.synacor.com