Installation.md

Installation

Table of contents

• Overview
• Docker
• Prerequisites for CPAN installation
• Local installation
  • Installation on Rocky Linux
  • Installation on Debian
  • Installation on Ubuntu
  • Installation on FreeBSD
• Post-installation sanity check
• Using zonemaster-cli
• What to do next?

Overview

This document describes prerequisites, installation and post-install sanity checking for Zonemaster::CLI. 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.

Docker

Zonemaster-CLI is available on Docker Hub and can be run on Docker without any installation, besides that Docker must be installed. See the USING Zonemaster-CLI document for how to run it on Docker. Links for installation of Docker are found there.

The rest of this document is about doing a local installation of Zonemaster-CLI, not relevant for running Zonemaster-CLI on Docker.

Prerequisites for CPAN installation

Before installing Zonemaster::CLI from CPAN, you should install Zonemaster::Engine, unless you are to install on Debian using pre-built packages (see below).

Note: Zonemaster::Engine and Zonemaster::LDNS are dependencies of Zonemaster::CLI. Zonemaster::LDNS has a special installation requirement, and Zonemaster::Engine has a list of dependencies that you may prefer to install from your operating system distribution (rather than CPAN). We recommend following the Zonemaster::Engine installation instruction.

Prerequisite for FreeBSD is that the package system is updated and activated (see the FreeBSD section of Zonemaster::Engine installation).

For details on supported versions of Perl and operating system for Zonemaster::CLI, see the declaration of prerequisites.

Local installation

Installation on Rocky Linux

1. Install binary dependencies:

   sudo dnf install perl-JSON-XS perl-MooseX-Getopt

2. Install dependencies from CPAN:

   sudo cpanm Text::Reflow

3. Install Zonemaster::CLI

   sudo cpanm Zonemaster::CLI

Installation on Debian

Using pre-built packages is the preferred method for Debian. If you prefer to install from CPAN instead, follow the steps for Ubuntu.

1. Add Zonemaster packages repository to repository list

   curl -LOs https://package.zonemaster.net/setup.sh
   sudo sh setup.sh

2. Install Zonemaster CLI

   sudo apt install zonemaster-cli

3. Update configuration of "locale"

   sudo perl -pi -e 's/^# (da_DK\.UTF-8.*|en_US\.UTF-8.*|fi_FI\.UTF-8.*|fr_FR\.UTF-8.*|nb_NO\.UTF-8.*|sv_SE\.UTF-8.*)/$1/' /etc/locale.gen
   sudo locale-gen

   After the update, locale -a should at least list the following locales:

   da_DK.utf8
   en_US.utf8
   fi_FI.utf8
   fr_FR.utf8
   nb_NO.utf8
   sv_SE.utf8
   

Installation on Ubuntu

1. Install dependencies:

   sudo apt-get install locales libmoosex-getopt-perl libtext-reflow-perl libmodule-install-perl

2. Install Zonemaster::CLI:

   sudo cpanm Zonemaster::CLI

3. Update configuration of "locale"

   sudo perl -pi -e 's/^# (da_DK\.UTF-8.*|en_US\.UTF-8.*|fi_FI\.UTF-8.*|fr_FR\.UTF-8.*|nb_NO\.UTF-8.*|sv_SE\.UTF-8.*)/$1/' /etc/locale.gen
   sudo locale-gen

   After the update, locale -a should at least list the following locales:

   da_DK.utf8
   en_US.utf8
   fi_FI.utf8
   fr_FR.utf8
   nb_NO.utf8
   sv_SE.utf8
   

Installation on FreeBSD

1. Become root:

   su -l

2. Install dependencies available from binary packages:

   pkg install devel/gmake p5-JSON-XS p5-Locale-libintl p5-MooseX-Getopt p5-Text-Reflow

3. Install Zonemaster::CLI:

   cpanm Zonemaster::CLI

Post-installation sanity check

Run the zonemaster-cli command:

zonemaster-cli --test basic zonemaster.net

The command is expected to take a few seconds and print some results about the delegation of zonemaster.net.

Using zonemaster-cli

See the USING Zonemaster-CLI document for an overview on how to use zonemaster-cli after installation.

What to do next?

• For a web GUI, follow the Zonemaster::Backend and Zonemaster::GUI installation instructions.
• For a JSON-RPC frontend, follow the Zonemaster::Backend installation instruction.