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.
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.
There are two ways to install the Zonemaster GUI:
Download the release zip file, upload to your web server, and configure.
Clone the repository, build, and deploy.
For detailed instructions, see INSTALL.md.
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
.envfile - Run
npm run dev
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.
A zip (zonemaster_web_gui_<version>.zip) is built and uploaded as a GitHub Actions artifact on every push and pull request. This artifact can be useful for release testing and PR review.
To download it:
- Go to the Actions tab of the repository.
- Select a workflow run (e.g. for a specific PR or branch).
- Scroll to the bottom of the run summary to the Artifacts section.
- Download the artifact named
zonemaster_web_gui_<version>-<short_sha>. The artifact name includes the module version and the first 7 characters of the commit SHA.
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.
Images src/assets/images/person_looking_at_computer.svg and src/assets/images/world_connected.svg are taken from https://undraw.co, full license.