aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Miek Gieben <miek@miek.nl> 2016-04-03 19:05:49 +0100
committerGravatar Miek Gieben <miek@miek.nl> 2016-04-03 19:05:49 +0100
commit80007f4729ca31d4dcfc884fd3f36d9df7c7d5b7 (patch)
tree9feb998dd4430c205079d3a6d13b15353e6331ca /README.md
parent7f36a853f79de0ecc3d899dea08629c6071f5437 (diff)
downloadcoredns-80007f4729ca31d4dcfc884fd3f36d9df7c7d5b7.tar.gz
coredns-80007f4729ca31d4dcfc884fd3f36d9df7c7d5b7.tar.zst
coredns-80007f4729ca31d4dcfc884fd3f36d9df7c7d5b7.zip
Better README
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 26 insertions, 5 deletions
diff --git a/README.md b/README.md
index 31489890d..92fc13402 100644
--- a/README.md
+++ b/README.md
@@ -3,16 +3,37 @@
CoreDNS is DNS server that started as a fork of [Caddy](https://github.com/mholt/caddy/). It has the
same model: it chains middleware.
-It is in the early stages of development and should **not** be used on production servers yet. For now most
-documentation is in the source and some blog articles can be [found
-here](https://miek.nl/tags/coredns/).
+## Status
+
+Currently CoreDNS is able to:
+
+* Serve zone data from a file, both DNSSEC (NSEC only atm) and DNS is supported.
+* Retrieve zone data from primaries, i.e. act as a secondary server.
+* Allow for zone transfers, i.e. act as a primary server.
+* Use Etcd as a backend, i.e. a 90% replacement for
+ [SkyDNS](https://github.com/skynetservices/skydns).
+* Serve as a proxy to forward queries to some other (recursive) nameserver.
+* Prove metrics (by using Prometheus)
+* Rewrite queries (both qtype and qname).
+* Provide Logging.
+
+There are corner cases not implement and some blatantly missing functionality; i.e. the secondary
+implement *does not* requery the primary -- *ever*.
+
+But all in all, CoreDNS should already be able to provide you with enough functionality to replace
+parts of BIND9, Knot, NSD or PowerDNS.
+
+CoreDNS is still in the early stages of development and should **not** be used on production servers
+yet. For now most documentation is in the source and some blog articles can be [found
+here](https://miek.nl/tags/coredns/). If you do want to use CoreDNS in production, please let us
+know and how we can help.
<https://caddyserver.com/> is also full of examples on how to structure a Corefile (renamed from
Caddyfile when I forked it).
-# Resolver
+## Proxy
-Start a simple resolver (proxy):
+Start a simple proxy:
`Corefile` contains: