aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Miek Gieben <miek@miek.nl> 2016-04-19 10:26:29 +0000
committerGravatar Miek Gieben <miek@miek.nl> 2016-04-19 10:26:29 +0000
commit913cffd4a803d3eaab95c876c467619d46d2aa32 (patch)
treee39877badfeb916ab0baa43fc7e6827e692c3fbc
parent10db2a80df36b3d64b0b62644c91420046d827f8 (diff)
downloadcoredns-913cffd4a803d3eaab95c876c467619d46d2aa32.tar.gz
coredns-913cffd4a803d3eaab95c876c467619d46d2aa32.tar.zst
coredns-913cffd4a803d3eaab95c876c467619d46d2aa32.zip
Updates to README
-rw-r--r--README.md3
-rw-r--r--middleware/cache/README.md13
2 files changed, 13 insertions, 3 deletions
diff --git a/README.md b/README.md
index b5a458097..4f6a702b8 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,8 @@ Currently CoreDNS is able to:
* Retrieve zone data from primaries, i.e. act as a secondary server.
* Loadbalancing of responses.
* Allow for zone transfers, i.e. act as a primary server.
-* Use etcd as a backend, i.e. a 94.5% replacement for
+* Caching
+* Use etcd as a backend, i.e. a 98.5% replacement for
[SkyDNS](https://github.com/skynetservices/skydns).
* Serve as a proxy to forward queries to some other (recursive) nameserver.
* Rewrite queries (both qtype, qclass and qname).
diff --git a/middleware/cache/README.md b/middleware/cache/README.md
index aade84694..fe15d6878 100644
--- a/middleware/cache/README.md
+++ b/middleware/cache/README.md
@@ -20,10 +20,19 @@ A cache mostly makes sense with a middleware that is potentially slow, i.e. a pr
answer, or to minimize backend queries for middleware like etcd. Using a cache with the file
middleware essentially doubles the memory load with no concealable increase of query speed.
+The minimum TTL allowed on resource records is 5 seconds.
+
## Examples
~~~
-cache
+cache 10
+~~~
+
+Enable caching for all zones, but cap everything to a TTL of 10 seconds.
+
+~~~
+proxy . 8.8.8.8:53
+cache miek.nl
~~~
-Enable caching for all zones.
+Proxy to Google Public DNS and only cache responses for miek.nl (or below).