The Zonemaster GUI - part of the Zonemaster project
Find a file
tgreenx 61d85f8c6f
Some checks failed
CI / Run end-to-end tests (push) Has been cancelled
Merge pull request #505 from tgreenx/new-gui-translation-nb
New GUI: Norwegian translation
2025-12-11 15:07:47 +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 branch 'releases/ssg-standalone-components' into new-gui-translation-nb 2025-12-11 15:05:56 +01:00
messages Merge branch 'releases/ssg-standalone-components' into new-gui-translation-nb 2025-12-11 15:05:56 +01:00
project.inlang add Slovenian language config 2025-08-27 08:41:48 +02:00
scripts Copies Apache configuration and license file to the zip file above the files served 2025-11-24 22:32:56 +01:00
src Merge branch 'releases/ssg-standalone-components' into new-gui-translation-nb 2025-12-11 15:05:56 +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 Added support for configurable pollingInterval 2025-04-30 09:13:54 +02: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 Creates a directory above the served to match current configuration 2025-11-24 22:32:56 +01:00
Changes Merge remote-tracking branch 'upstream/feature/ssg-standalone-components' into ssg-standalone-components 2025-11-19 10:21:41 +01:00
config.ts add Slovenian language config 2025-08-27 08:41:48 +02: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 Added svelte plugin for prettier 2025-09-22 16:45:03 +02:00
package.json Sets version for v2025.2 release 2025-11-24 22:32:56 +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 Sets the same document root as used today 2025-11-24 22:32:56 +01:00

Zonemaster Web GUI CI status

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:

  1. Clone the repository
  2. Run npm install
  3. Run cp .env.example .env
  4. Set the URL to your Zonemaster backend in the .env file
  5. 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.

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