Mirrors/coredns
1
0
Fork 0
mirror of https://github.com/coredns/coredns.git synced 2025-10-27 08:14:18 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: update README and log plugin (#3602)

Browse Source 
README: remove the logo thing as we stopped doing that
log: remote the lines about the clock output as that's gone as well and
     discuss the query log vs other logging a bit.

Signed-off-by: Miek Gieben <miek@miek.nl>
This commit is contained in:
Miek Gieben
2020-01-17 16:16:29 +01:00
committed by GitHub
parent aa8c325d4a
commit c95faea624
2 changed files with 17 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -77,25 +77,20 @@ The above command alone will have `coredns` binary generated.
## Examples
When starting CoreDNS without any configuration, it loads the
[*whoami*](https://coredns.io/plugins/whoami) plugin and starts listening on port 53 (override with
`-dns.port`), it should show the following:
[*whoami*](https://coredns.io/plugins/whoami) and [*log*](https://coredns.io/plugins/log) plugins
and starts listening on port 53 (override with `-dns.port`), it should show the following:
~~~ txt
.:53
______ ____ _ _______
/ ____/___ ________ / __ \/ | / / ___/ ~ CoreDNS-1.6.3
/ / / __ \/ ___/ _ \/ / / / |/ /\__ \ ~ linux/amd64, go1.13,
/ /___/ /_/ / / / __/ /_/ / /| /___/ /
\____/\____/_/ \___/_____/_/ |_//____/
CoreDNS-1.6.6
linux/amd64, go1.13.5, aa8c32
~~~
Any query sent to port 53 should return some information; your sending address, port and protocol
used.
used. The query should also be logged to standard output.
If you have a Corefile without a port number specified it will, by default, use port 53, but you can
override the port with the `-dns.port` flag:
`./coredns -dns.port 1053`, runs the server on port 1053.
override the port with the `-dns.port` flag: `coredns -dns.port 1053`, runs the server on port 1053.
Start a simple proxy. You'll need to be root to start listening on port 53.
@@ -108,11 +103,11 @@ Start a simple proxy. You'll need to be root to start listening on port 53.
}
~~~
Just start CoreDNS: `./coredns`. Then just query on that port (53). The query should be forwarded
to 8.8.8.8 and the response will be returned. Each query should also show up in the log which is
printed on standard output.
Start CoreDNS and then query on that port (53). The query should be forwarded to 8.8.8.8 and the
response will be returned. Each query should also show up in the log which is printed on standard
output.
Serve the (NSEC) DNSSEC-signed `example.org` on port 1053, with errors and logging sent to standard
To serve the (NSEC) DNSSEC-signed `example.org` on port 1053, with errors and logging sent to standard
output. Allow zone transfers to everybody, but specifically mention 1 IP address so that CoreDNS can
send notifies to it.
@@ -139,6 +134,7 @@ example.org:1053 {
errors
log
}
. {
any
forward . 8.8.8.8:53