aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar John Belamaric <jbelamaric@infoblox.com> 2017-04-19 17:43:10 -0400
committerGravatar Miek Gieben <miek@miek.nl> 2017-04-19 22:43:10 +0100
commite5b2cbb7014397eddb6d5d8f72e7bb8d6de092c4 (patch)
tree6348aaddc9726f9373656932ca71d55e9149cdf8
parent8fc7ec776dfecf29ff34481e2e826a02968419a1 (diff)
downloadcoredns-e5b2cbb7014397eddb6d5d8f72e7bb8d6de092c4.tar.gz
coredns-e5b2cbb7014397eddb6d5d8f72e7bb8d6de092c4.tar.zst
coredns-e5b2cbb7014397eddb6d5d8f72e7bb8d6de092c4.zip
Clean up the tls middleware README (#631)
-rw-r--r--middleware/tls/README.md26
1 files changed, 22 insertions, 4 deletions
diff --git a/middleware/tls/README.md b/middleware/tls/README.md
index 6070257d3..bb7494eb8 100644
--- a/middleware/tls/README.md
+++ b/middleware/tls/README.md
@@ -1,13 +1,31 @@
# tls
-*tls* extra TLS configuration.
+*tls* allows you to configure the server certificates for the TLS and gRPC servers.
+For other types of servers it is ignored.
## Syntax
~~~ txt
-tls [STUFF]
+tls CERT KEY CA
~~~
-**STUFF** is things you'll need to configure TLS.
-
## Examples
+
+Start a DNS-over-TLS server.
+
+~~~
+tls://.:4453 {
+ tls cert.pem key.pem ca.pem
+ proxy . /etc/resolv.conf
+}
+~~~
+
+Start a DNS-over-gRPC server. If the `tls` directive were omitted, then
+it would use plain HTTP not HTTPS.
+
+~~~
+grpc://.:443 {
+ tls cert.pem key.pem ca.pem
+ proxy . /etc/resolv.conf
+}
+~~~