Installation.md

Installation

Table of contents

• Overview
• Docker
• Prerequisites
• Local installation
  • Installation on Rocky Linux
  • Installation on Debian
  • Installation on Ubuntu
  • Installation on FreeBSD
• Post-installation sanity check
• What to do next

Overview

This document describes prerequisites, installation, post-install sanity checking for Zonemaster::Engine, and rounds up with a few pointer to interfaces for Zonemaster::Engine. For an overview of the Zonemaster product, please see the main Zonemaster Repository.

Docker

Zonemaster-CLI is available on Docker Hub, and can be conveniently downloaded and run without any installation. See USING Zonemaster-CLI for how to run Zonemaster-CLI on Docker.

To build your own Docker image, see the Docker Image Creation documentation.

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

Prerequisites

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

Local installation

Installation on Rocky Linux

1. Enable PowerTools:

   sudo dnf config-manager --set-enabled powertools

2. Install the EPEL repository:

   sudo dnf --assumeyes --enablerepo=extras install epel-release

3. Install binary packages:

   sudo dnf --assumeyes install cpanminus gcc libidn-devel openssl-devel perl-Class-Accessor perl-Clone perl-core perl-Devel-CheckLib perl-Email-Valid perl-File-ShareDir perl-File-Slurp perl-libintl perl-IO-Socket-INET6 perl-JSON-PP perl-List-MoreUtils perl-Module-Find perl-Module-Install perl-Moose perl-Net-IP perl-Pod-Coverage perl-Readonly perl-Test-Differences perl-Test-Exception perl-Test-Fatal perl-Test-NoWarnings perl-Test-Pod perl-Text-CSV perl-Test-Simple perl-YAML

4. Install packages from CPAN:

   sudo cpanm Module::Install::XSUtil MooseX::Singleton

5. Install Zonemaster::LDNS and Zonemaster::Engine:

   sudo cpanm Zonemaster::LDNS Zonemaster::Engine

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. Upgrade to latest patch level

   sudo apt update && sudo apt upgrade

2. Add Zonemaster packages repository to repository list

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

3. Install Zonemaster CLI

   sudo apt install libzonemaster-engine-perl

Installation on Ubuntu

1. Upgrade to latest patch level

   sudo apt update && sudo apt upgrade

2. Install dependencies from binary packages:

   sudo apt install autoconf automake build-essential cpanminus libclass-accessor-perl libclone-perl libdevel-checklib-perl libemail-valid-perl libfile-sharedir-perl libfile-slurp-perl libidn11-dev libintl-perl libio-socket-inet6-perl libjson-pp-perl liblist-moreutils-perl libmodule-find-perl libmodule-install-perl libmodule-install-xsutil-perl libmoose-perl libmoosex-singleton-perl libnet-ip-perl libpod-coverage-perl libreadonly-xs-perl libssl-dev libtest-differences-perl libtest-exception-perl libtest-fatal-perl libtest-nowarnings-perl libtest-pod-perl libtext-csv-perl libtool m4

3. Install Zonemaster::LDNS and Zonemaster::Engine.

   sudo cpanm Zonemaster::LDNS Zonemaster::Engine

Installation on FreeBSD

1. Become root:

   su -l

2. Update list of package repositories:

   Create the file /usr/local/etc/pkg/repos/FreeBSD.conf with the following content, unless it is already updated:

   FreeBSD: {
   url: "pkg+http://pkg.FreeBSD.org/${ABI}/latest",
   }
   

3. Check or activate the package system:

   Run the following command, and accept the installation of the pkg package if suggested.

   pkg info -E pkg
   

4. Update local package repository:

   pkg update -f
   

5. Install dependencies from binary packages:

   pkg install devel/gmake libidn p5-App-cpanminus p5-Class-Accessor p5-Clone p5-Devel-CheckLib p5-Email-Valid p5-File-ShareDir p5-File-Slurp p5-IO-Socket-INET6 p5-JSON-PP p5-List-MoreUtils p5-Locale-libintl p5-Module-Find p5-Module-Install p5-Module-Install-XSUtil p5-Moose p5-MooseX-Singleton p5-Net-IP-XS p5-Pod-Coverage p5-Readonly-XS p5-Test-Differences p5-Test-Exception p5-Test-Fatal p5-Test-NoWarnings p5-Test-Pod p5-Text-CSV net-mgmt/p5-Net-IP dns/ldns

6. Install Zonemaster::LDNS:

   cpanm --configure-args="--no-internal-ldns" Zonemaster::LDNS

7. Install Zonemaster::Engine:

   cpanm Zonemaster::Engine

Post-installation sanity check

Make sure Zonemaster::Engine is properly installed.

time perl -MZonemaster::Engine -E 'say join "\n", Zonemaster::Engine->test_module("BASIC", "zonemaster.net")'

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

What to do next

• For a command line interface, follow the Zonemaster::CLI installation instruction.
• For a web interface, follow the Zonemaster::Backend installation and Zonemaster::GUI installation instructions.
• For a JSON-RPC API, follow the Zonemaster::Backend installation instruction.
• For a Perl API, see the Zonemaster::Engine API documentation.