Installation
Overview
This document describes an abstract, prerequisites, installation and post-install sanity checking for Zonemaster::GUI. The final section wraps up with a few pointer to other interfaces to Zonemaster. For an overview of the Zonemaster product, please see the main Zonemaster Repository.
Prerequisites
Before installing Zonemaster::GUI, you should [install Zonemaster::Engine][ Zonemaster::Engine installation] and Zonemaster::Backend.
Note: Zonemaster::Backend, and consequently Zonemaster::Engine and Zonemaster::LDNS are dependencies of Zonemaster::GUI. Zonemaster::LDNS has a special installation requirement, and both Zonemaster::Engine and Zonemaster::Backend have lists of dependencies that you may prefer to install from your operating system distribution (rather than CPAN). We recommend following the Zonemaster::Engine and Zonemaster::Backend installation instruction.
For details on supported versions of Perl and operating system for Zonemaster::CLI, see the declaration of prerequisites.
Installation
This instruction covers the following operating systems:
1. CentOS
Install dependencies available from binary packages:
sh
sudo cpan -i Dancer Text::Markdown Template JSON
Install Zonemaster::GUI:
sh
sudo cpan -i Zonemaster::GUI
Start the web server:
sh
sudo /usr/local/bin/starman --listen=:80 --daemonize `perl -MFile::ShareDir=dist_file -e 'print dist_file("Zonemaster-GUI", "bin/app.pl")'`
2. Debian
Install dependencies available from binary packages:
sh
sudo apt-get install libdancer-perl libtext-markdown-perl libtemplate-perl libjson-any-perl
Install Zonemaster::GUI:
sh
sudo cpan -i Zonemaster::GUI
Start the web server:
sh
sudo starman --listen=:80 --daemonize `perl -MFile::ShareDir=dist_file -e 'print dist_file("Zonemaster-GUI", "bin/app.pl")'`
The Doc directory in the source code also has an example Upstart file for the Web GUI starman server.
3. Docker
Install the docker package on your OS
Follow the installation instructions for your OS -> https://docs.docker.com/engine/installation/linux/
Pull the docker image containing the complete Zonemaster distribution (GUI + Backend + Engine)
docker pull afniclabs/zonemaster-gui
Start the container in the background
docker run -t -p 50080:50080 afniclabs/zonemaster-gui
Use the Zonemaster GUI by pointing your browser at
http://localhost:50080/
Use the Zonemaster engine from the command line
docker run -t -i afniclabs/zonemaster-gui bash
4. FreeBSD
Become root:
sh
su -l
Install dependencies available from binary packages:
sh
pkg install p5-Dancer p5-Text-Markdown p5-Template-Toolkit
Install Zonemaster::GUI:
sh
cpan -i Zonemaster::GUI
Start the web server:
sh
starman --listen=:80 --daemonize `perl -MFile::ShareDir=dist_file -e 'print dist_file("Zonemaster-GUI", "bin/app.pl")'`
5. Ubuntu
Use the procedure for installation on Debian.
Post-installation sanity check
Point your browser at http://localhost/ (or the address of the server where
you installed Zonemaster::GUI).
Note: For the Docker installation, the URL is http://localhost:50080/.
Verify that the Zonemaster GUI is shown with the "Zonemaster Test Engine Version" in its page footer.
What to do next?
- For a JSON-RPC API, see the Zonemaster::Backend JSON-RPC API documentation.
- For a command line interface, follow the Zonemaster::CLI installation instruction.
- For a Perl API, see the Zonemaster::Engine API documentation.
Copyright (c) 2013 - 2017, IIS (The Internet Foundation in Sweden) \ Copyright (c) 2013 - 2017, AFNIC \ Creative Commons Attribution 4.0 International License
You should have received a copy of the license along with this work. If not, see https://creativecommons.org/licenses/by/4.0/.