From 85db27cddeab2a9c8be9df38e2f78d99b4594a54 Mon Sep 17 00:00:00 2001 From: Niklas Date: Sat, 26 Dec 2020 16:45:54 +0100 Subject: [PATCH] added README --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5db9e1a --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# Cool dns + +A simple dns server written in Go. It supports zonefile parsing, different zones based on IP and forwarding. + +# Configuration + +Example config file +```yaml +zones: +- zone: example.com. # Fully qualified domain name of the zone + file: zonefile.txt # Path to the zonefile to parse + +- zone: example.com. + file: zonefile2.txt + acl: # What IPs can query the zone + - lan + +acl: # List of ip filter rules +- name: vpn # Name of the rule + cidr: 10.0.0.0/24 # CIDR of the rule +- name: lan + cidr: 192.168.0.0/16 +- name: local + cidr: 127.0.0.1/32 + +forward: + acl: # What IPs are allowed + - vpn + server: "8.8.8.8:53" # DNS server to forward to + +address: 0.0.0.0:8053 # What address and port to listen on +``` \ No newline at end of file