mirror of https://github.com/zonemaster/zonemaster-gui.git synced 2026-01-19 12:34:13 +01:00

The Zonemaster GUI - part of the Zonemaster project

Find a file

Mats Dufberg 0aa6ac964f Some checks failed CI / Run end-to-end tests (push) Has been cancelled Details Merge pull request #528 from zonemaster/master Merge pull request #527 from zonemaster/develop		2025-12-19 15:55:44 +01:00
.github	Updates mpm version for CI	2025-11-19 13:40:10 +00:00
.vscode	Build improvements	2025-04-14 08:00:14 +02:00
demo	Added support for configurable pollingInterval	2025-04-30 09:13:54 +02:00
docs	Apply suggestions from document review	2025-12-03 14:17:53 +01:00
e2e	Merge pull request #507 from tgreenx/new-gui-translation-da	2025-12-16 10:48:58 +01:00
messages	Merge pull request #507 from tgreenx/new-gui-translation-da	2025-12-16 10:48:58 +01:00
scripts	Refactor message generation and validation logic	2025-12-15 21:49:27 +01:00
src	Simplify and make filtered result reactive	2025-12-18 13:19:13 +01:00
static	add message banner and docmentation	2025-06-05 08:43:48 +02:00
.browserslistrc	Update master to state of develop	2021-12-06 00:33:02 +01:00
.editorconfig	Prettier	2025-03-13 09:53:53 +01:00
.env.example	Allow serving the GUI from a subdirectory	2025-12-15 08:35:37 +01:00
.gitignore	add vendor to gitignore	2025-10-29 14:07:27 +01:00
.prettierignore	Prettier setup	2025-02-10 07:30:41 +01:00
.prettierrc	Added svelte plugin for prettier	2025-09-22 16:45:03 +02:00
astro.config.mjs	Custom i18n solution to replace paraglide	2025-12-15 21:49:25 +01:00
Changes	Merge pull request #524 from matsduf/preparation-release-v2025.2	2025-12-18 16:20:18 +01:00
config.ts	Allow serving the GUI from a subdirectory	2025-12-15 08:35:37 +01:00
CONTRIBUTE.md	Added contribution guidelines	2025-05-12 13:32:55 +02:00
LICENSE	Update master to state of develop	2021-12-06 00:33:02 +01:00
package-lock.json	Updated patches	2025-12-15 21:49:27 +01:00
package.json	Updated patches	2025-12-15 21:49:27 +01:00
playwright.config.ts	Updates for e2e tests	2025-11-24 21:15:46 +00:00
README.md	Updated readme and added config documentation	2025-06-15 21:42:58 +02:00
svelte.config.js	Add input names and improve TypeScript types for event handling	2025-04-14 09:44:23 +02:00
tsconfig.json	Read version from package.json	2025-06-04 12:01:36 +02:00
zonemaster-nginx.conf-example	Fix typos in nginx example configuration	2025-12-03 14:59:18 +01:00
zonemaster.conf-example	Allow serving the GUI from a subdirectory	2025-12-15 08:35:37 +01:00

README.md

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.