# dns

> A DNS Server with a REST API

Latest version **0.2.2** (published 2014-09-17) · 0 weekly downloads

## Install

```sh
npm install dns
pnpm add dns
yarn add dns
bun add dns
```

Provides the command `dns`.

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2014-09-17 |
| First published | 2014-06-29 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10.0 < 0.11.0 |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 182 |
| Author | Henri Bouvier |
| Maintainers | hbouvier |
| Keywords | dns, REST |

## Links

- npm: https://www.npmjs.com/package/dns
- Repository: https://github.com/hbouvier/dns
- Issues: https://github.com/hbouvier/dns/issues
- npm.io page: https://npm.io/package/dns

## Dependencies (6)

- [winston](https://npm.io/package/winston.md) 0.7.3
- [hbo-dnsd](https://npm.io/package/hbo-dnsd.md) 0.9.8
- [tomahawk](https://npm.io/package/tomahawk.md) 0.1.6
- [native-dns](https://npm.io/package/native-dns.md) 0.6.1
- [node-options](https://npm.io/package/node-options.md) 0.0.6
- [tomahawk-plugin-kv-memory-store](https://npm.io/package/tomahawk-plugin-kv-memory-store.md) 0.0.3

## Recent versions

- 0.2.2 (latest) — 2014-09-17
- 0.2.1 — 2014-09-17
- 0.2.0 — 2014-09-16
- 0.1.5 — 2014-09-16
- 0.1.4 — 2014-07-23
- 0.1.3 — 2014-07-23
- 0.1.2 — 2014-07-07
- 0.1.1 — 2014-07-06
- 0.1.0 — 2014-07-06
- 0.0.9 — 2014-07-05
- 0.0.8 — 2014-07-01
- 0.0.7 — 2014-06-29

## README

[![Build Status](https://travis-ci.org/hbouvier/dns.png)](https://travis-ci.org/hbouvier/dns)
[![dependency Status](https://david-dm.org/hbouvier/dns/status.png?theme=shields.io)](https://david-dm.org/hbouvier/dns#info=dependencies)
[![devDependency Status](https://david-dm.org/hbouvier/dns/dev-status.png?theme=shields.io)](https://david-dm.org/hbouvier/dns#info=devDependencies)
[![NPM version](https://badge.fury.io/js/dns.png)](http://badge.fury.io/js/dns)

DNS
===

A DNS Server with an Web UI and using Redis a configuration store

## Installation

	brew install redis
	sudo npm install -g dns

## Startup

	/usr/local/opt/redis/bin/redis-server /usr/local/etc/redis.conf >& /tmp/redis.log &
	sudo dns >& /tmp/dns.log &

## Web UI

	open http://localhost:8053

## REDIS CONFIGURATION

	REDIS_PORT_6379_TCP_ADDR  (default: 127.0.0.1)
    REDIS_PORT_6379_TCP_PORT  (default: 6379)

## DNS CONFIGURATION

    DNSINTERFACE (default: 0.0.0.0)
    DNSPORT      (default: 53 <- require root privilege to run)
    DNSZONE      (default: local.dev)
    DNSTTL       (default: 3600 <- one hour)
    DNSPREFIX    (default: "dns:" <- key prefix in redis)
    DNSPRIMARY   (default: 8.8.8.8)
    DNSSECONDARY (default: 8.8.4.4)
    DNSTIMEOUT   (default: 1000 <- 1 second)

## REST ROUTES

	* GET /dns/api/v1/name

		List all host to ip address mapping

	* GET /dns/api/v1/name/{host}

		Return the ip address of only that host

	* PUT /dns/api/v1/name/{host}

		Create or Modify the ip address for "host"

	* DELETE /dns/api/v1/name/{host}

		Remove the host from the DNS

	* DELETE /dns/api/v1/name?force=true

		Remove all host from the DNS

	* GET /dns/api/v1/zone

		Return the DNS ZONE

	* GET /dns/api/v1/status

		Return the DNS status


## To create or modify a host in the DNS configuration

    Single host
	curl -X PUT -H 'Content-Type: application/json' -d '{"ipv4":["192.168.1.1"], "ipv6":["2605:f8b0:4006:802:0:0:0:1010"]}' http://localhost:8053/dns/api/v1/name/database.domain.com
	
	Multiple hosts
    curl -X PUT -H 'Content-Type: application/json' -d '{"ipv4":["192.168.1.1","192.168.1.2"], "ipv6":["2605:f8b0:4006:802:0:0:0:1010","2605:f8b0:4006:802:0:0:0:1011"]}' http://localhost:8053/dns/api/v1/name/database.domain.com

## To query the address of a host

	curl http://localhost:8053/dns/api/v1/name/database.domain.com
	or
	dig @127.0.0.1 database.domain.com
	or
	dig @127.0.0.1 database.domain.com AAAA

## To remove a host from the registry

	curl -X DELETE http://localhost:8053/dns/api/v1/name/database.domain.com

# UPGRADING from 0.0.9 or 0.1.0 to a version greater than 0.1.0

You will need to clear your redis configuration before running the new version.

    curl -X DELETE http://localhost:8053/dns/api/v1/name\?force\=true
    or
    for key in `echo 'KEYS dns*' | redis-cli | awk '{print $1}'` ; do echo DEL $key ; done | redis-cli

---
_Source: https://npm.io/package/dns · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._