{"id":26937977,"url":"https://github.com/holysoles/zoneforge","last_synced_at":"2026-03-01T00:04:29.858Z","repository":{"id":272549310,"uuid":"916785607","full_name":"holysoles/zoneforge","owner":"holysoles","description":"Web Frontend and REST API for DNS Zonefile Management","archived":false,"fork":false,"pushed_at":"2025-09-29T21:42:31.000Z","size":487,"stargazers_count":3,"open_issues_count":21,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-13T17:29:44.583Z","etag":null,"topics":["api","bind","coredns","dns","dns-record","flask","python","rest","zonefile"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/holysoles.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-01-14T18:54:11.000Z","updated_at":"2025-09-29T21:41:27.000Z","dependencies_parsed_at":"2025-05-02T01:37:11.041Z","dependency_job_id":null,"html_url":"https://github.com/holysoles/zoneforge","commit_stats":null,"previous_names":["holysoles/zoneforge"],"tags_count":21,"template":false,"template_full_name":null,"purl":"pkg:github/holysoles/zoneforge","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/holysoles%2Fzoneforge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/holysoles%2Fzoneforge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/holysoles%2Fzoneforge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/holysoles%2Fzoneforge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/holysoles","download_url":"https://codeload.github.com/holysoles/zoneforge/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/holysoles%2Fzoneforge/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29955885,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-28T22:53:01.873Z","status":"ssl_error","status_checked_at":"2026-02-28T22:52:50.699Z","response_time":90,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","bind","coredns","dns","dns-record","flask","python","rest","zonefile"],"created_at":"2025-04-02T13:16:37.153Z","updated_at":"2026-03-01T00:04:29.818Z","avatar_url":"https://github.com/holysoles.png","language":"Python","readme":"# ZoneForge\n\nZoneForge is a web UI and REST API to manage [RFC1035](https://rfc-annotations.research.icann.org/rfc1035.html)/BIND style DNS zone files. \n\n![GitHub License](https://img.shields.io/github/license/holysoles/zoneforge)\n![Issues](https://img.shields.io/github/issues/holysoles/zoneforge)\n[![codecov](https://codecov.io/gh/holysoles/zoneforge/graph/badge.svg?token=AXBMFUU5G0)](https://codecov.io/gh/holysoles/zoneforge)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)\n\n![record management screenshot](lib/screenshots/record_management.png)\n\n## About\n\nZoneForge provides a web-based interface and REST API for managing DNS records efficiently. Rather than re-inventing an entire DNS server, ZoneForge serves as a management layer for RFC1035/BIND-style DNS zone files. This project is ideal for administrators who require:\n- A centralized, user-friendly tool to manage DNS records.\n- Robust REST API.\n- Deployment flexibility for various environments.\n\nZone files are a commonly supported standard for serving [authoritative DNS](https://en.wikipedia.org/wiki/Name_server#Authoritative_name_server) zone records, such as in [BIND](https://www.isc.org/bind/), [NSD](https://github.com/NLnetLabs/nsd), and [CoreDNS's file plugin](https://coredns.io/plugins/file/). While these DNS servers are highly-perfomant and lightweight, they often lack user-friendly management tools, which is where ZoneForge comes in.\n\n## Table of Contents\n- [About](#about)\n- [Demo](#demo)\n- [Installation](#installation)\n- [Configuration](#configuration)\n- [REST API](#rest-api)\n  - [Overview](#overview)\n  - [Documentation](#documentation)\n- [Web UI](#web-ui)\n- [Feature Roadmap](#feature-roadmap)\n- [Resources](#resources)\n  - [Zone Files](#zone-files)\n  - [Record Types](#record-types)\n  - [RFCs](#rfcs)\n  - [Migrating Existing DNS to a Zone File](#migrating-existing-dns-to-a-zone-file)\n- [Credits](#credits)\n\n# Demo\n\nA public demo, with sample data, is [currently deployed here](https://zoneforge.pve.dev). It runs the latest released Docker image (polled every 15 minutes).\n\nMany replicas are deployed, load balanced with session affinity. Instances are torn down nightly to reset the container.\n\n# Installation\n\nDeployment using [the published Docker image](https://github.com/holysoles/zoneforge/pkgs/container/zoneforge) is preferred, as it is tested and includes setup for using Gunicorn as a production WSGI server. Deploy it via Docker/Docker Compose/Kubernetes. Simple usage might look like:\n\n```bash\ndocker run -d --rm \\\n  -e ZONE_FILE_FOLDER=/etc/zones \\\n  -v /path/to/zonefiles:/etc/zones \\\n  -p 5000:5000 \\\n  ghcr.io/holysoles/zoneforge:latest\n```\n\nLocal installation should work as well. Check the Dockerfile for the latest targeted Python version.\n\n```bash\ngit clone https://github.com/holysoles/zoneforge.git\ncd zoneforge\npython -m venv .venv\nsource .venv/bin/activate\npip install -r requirements/prod.txt\ngunicorn app:production --bind 0.0.0.0:5000 --workers 4\n```\n\n# Configuration\n\nEnvironment variables are available to configure the application. Additional information about Gunicorn configuration can be found [here](https://docs.gunicorn.org/en/latest/run.html).\n\n| Variable | Default | Description |\n| -------- | ------- | ----------- |\n| ZONE_FILE_FOLDER | `\"./lib/examples\"` | The folder path to store/load zone files. |\n| DEFAULT_ZONE_TTL | `86400` | The default TTL for new zones. |\n| LOG_LEVEL | `\"WARNING\"` | Log level for the application. Options: [`\"DEBUG\"`, `\"INFO\"`, `\"WARNING\"`, `\"ERROR\"`, `\"CRITICAL\"`] |\n| PORT | `5000` | Port for the web server to listen on. |\n| GUNICORN_WORKERS | `4` | How many worker processes to use for Gunicorn. |\n| GUNICORN_CMD_ARGS | `\"--bind 0.0.0.0:\\${PORT} --workers \\${GUNICORN_WORKERS}\"` | The command line arguments to pass Gunicorn. |\n\n# REST API\n\n## Overview\n\n- **Zones**: Create, Read, Update, Delete\n- **Records**: Create, Read, Update, Delete\n  - EOL comments are supported in the `comment` parameter in record related requests.\n  - Note that deprecated DNS record types are not supported by ZoneForge.\n- **Record Type Info**: Read\n- **Server Status**: Read\n\n## Documentation\n\nFor comprehensive examples, check out [the Swagger/OpenAPI (v2.0) documentation here](https://zoneforge.pve.dev/api)! You can also [import the spec into Postman](https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-from-swagger/).\n\nThis documentation is also available in local instances `/api`. \n\n# Web UI\n\nThe web UI is written with a focus on being lightweight for ease of maintenance and speed. This is accomplished with Flask templating and server-side rendering whenever possible, with minimal client side javascript with no external dependencies.\n\n# Feature Roadmap\n\n| **Feature**                             | **Status**         |\n|-----------------------------------------|--------------------|\n| **Web Interface**                       |                    |\n|  CRUD for DNS Zones                    | Complete          |\n|  CRUD for DNS Records                  | Complete          |\n|  Client side validation                | Planned           |\n| **REST API**                            |                    |\n|  CRUD for DNS Zones                    | Complete          |\n|  CRUD for DNS Records                  | Complete          |\n|  Thread Safety for DNS Record CRUD     | Backlog           |\n|  Zone Name Mutability                  | Backlog           |\n|  Patch Method for DNS Zones            | Backlog           |\n|  Patch Method for DNS Records          | Backlog           |\n| **Management**                          |                    |\n|  Authentication                        | In Progress       |\n|  Zone Import/Export                    | Backlog           |\n|  Preserve Default Zone TTL             | Backlog           |\n| **CI/CD**                               |                    |\n|  Docker Image                          | Complete          |\n|  Test Suite                            | Complete          |\n|  Package for PyPi/pip                  | Backlog           |\n|  CoreDNS Kubernetes Integration        | Backlog           |\n\n\n# Resources\n\n## Zone Files\n\n- [Zone File Validator](https://checkzone.dev/) by @woodjme\n- [DYN](https://help.dyn.com/how-to-format-a-zone-file/)\n- [Oracle](https://docs.oracle.com/en-us/iaas/Content/DNS/Reference/formattingzonefile.htm)\n\n## Record Types\n\n- [Microsoft Overview](https://learn.microsoft.com/en-us/azure/dns/dns-zones-records)\n\n## RFCs\n\n- [RFC1035](https://www.rfc-editor.org/rfc/rfc1035.html)\n- [RFC1183](https://www.rfc-editor.org/rfc/rfc1183.html)\n\n## Migrating Existing DNS to a Zone File\n\nFor each domain that a given DNS server is authorative for:\n\n1. First ensure that the zone is enabled for Zone transfer. For Windows DNS, this can be found by right-clicking the Zone -\u003e Properties -\u003e Zone Transfers.\n\n2. Install `dig` on a unix-like system\n\n3. Find the name servers if necessary: `dig example.com -t ns`\n\n4. Initiate the Zone Transfer: `dig axfr example.com @dns.example.com | grep -E -v '^;' \u003e db.example.com`\n\n5. The file `db.example.com` should now contain a RFC1035-compatible zone file.\n\n# Contributing\n\nContributions are welcome. Please follow [conventional commit syntax](https://www.conventionalcommits.org/en/v1.0.0/).\n\nInstall requirements for a dev environment with `pip install -r requirements/dev.txt`.\n\nPlease note that linting and unit tests are run against Pull Requests. It is recommended you test at least the Python related jobs before committing:\n\n```bash\nblack .\npylint $(git ls-files '*.py' | grep -v dnspython)\npytest\n```\n\nFor GitHub Actions, [pin-github-action](https://github.com/mheap/pin-github-action) is used to update tag refs to commit hashes\n\n# Credits\n\nSpecial thanks to the following projects for providing essential libraries:\n- [dnspython](https://github.com/rthalley/dnspython)\n- [Flask](https://github.com/pallets/flask)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fholysoles%2Fzoneforge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fholysoles%2Fzoneforge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fholysoles%2Fzoneforge/lists"}