Zonemaster Web GUI

Overview

Zonemaster GUI is the web interface component of the Zonemaster project, a tool designed for DNS validation and testing. For a comprehensive overview of the Zonemaster software, please see the Zonemaster repository.

Prerequisites

Before installing the Zonemaster GUI, ensure you have the Zonemaster Engine and Zonemaster-Backend setup. Refer to the Zonemaster-Engine installation and Zonemaster-Backend installation documents.

Installation

There are two ways to install the Zonemaster GUI:

Quick Install (1 minute)

Download the release zip file, upload to your web server, and configure.

Full Customization (5 minutes)

Clone the repository, build, and deploy.

For detailed instructions, see INSTALL.md.

Development

To set up your development environment:

Clone the repository
Run npm install
Run cp .env.example .env
Set the URL to your Zonemaster backend in the .env file
Run npm run dev

Documentation

Refer to the docs directory for detailed information on:

Installation and configuration
Theming and customization
Translation guide
Testing
UI documentation

For contribution guidelines, see CONTRIBUTE.md.

License

This is free software under a 2-clause BSD license. The full text of the license can be found in the LICENSE file included in this repository.

Images src/assets/images/person_looking_at_computer.svg and src/assets/images/world_connected.svg are taken from https://undraw.co, full license.

2.7 KiB Raw Permalink Blame History