Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
C
Coredns
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Locked Files
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Security & Compliance
Security & Compliance
Dependency List
License Compliance
Packages
Packages
List
Container Registry
Analytics
Analytics
CI / CD
Code Review
Insights
Issues
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Railgun
Coredns
Commits
63840bc2
Commit
63840bc2
authored
Aug 22, 2016
by
cricketliu
Committed by
GitHub
Aug 22, 2016
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update README.md
Minor grammatical fixes.
parent
5318e108
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
22 additions
and
22 deletions
+22
-22
README.md
README.md
+22
-22
No files found.
README.md
View file @
63840bc2
# CoreDNS
# CoreDNS
CoreDNS is DNS server that started as a fork of
[
Caddy
](
https://github.com/mholt/caddy/
)
. It has the
CoreDNS is
a
DNS server that started as a fork of
[
Caddy
](
https://github.com/mholt/caddy/
)
. It has the
same model: it chains middleware. In fact
t
o similar that CoreDNS is now a server type plugin for
same model: it chains middleware. In fact
it's s
o similar that CoreDNS is now a server type plugin for
C
Addy, i.e.
you'll need Caddy to compile CoreDNS.
C
addy, i.e.,
you'll need Caddy to compile CoreDNS.
CoreDNS is the successor
of
[
SkyDNS
](
https://github.com/skynetservices/skydns
)
. SkyDNS is a thin
CoreDNS is the successor
to
[
SkyDNS
](
https://github.com/skynetservices/skydns
)
. SkyDNS is a thin
layer that exposes services in etcd in the DNS. CoreDNS builds on this idea and is a generic DNS
layer that exposes services in etcd in the DNS. CoreDNS builds on this idea and is a generic DNS
server that can talk to multiple backends (etcd, consul, kubernetes, etc.).
server that can talk to multiple backends (etcd, consul, kubernetes, etc.).
CoreDNS aims to be a fast and flexible DNS server. The keyword here is
*flexible*
,
with CoreDNS you
CoreDNS aims to be a fast and flexible DNS server. The keyword here is
*flexible*
:
with CoreDNS you
are able to do what you want with your DNS data. And if not: write
a
middleware!
are able to do what you want with your DNS data. And if not: write
some
middleware!
Currently CoreDNS is able to:
Currently CoreDNS is able to:
*
Serve zone data from a file
, both DNSSEC (NSEC only) and DNS is
supported (middleware/file).
*
Serve zone data from a file
; both DNSSEC (NSEC only) and DNS are
supported (middleware/file).
*
Retrieve zone data from primaries, i.e. act as a secondary server (AXFR only) (middleware/secondary).
*
Retrieve zone data from primaries, i.e.
,
act as a secondary server (AXFR only) (middleware/secondary).
*
Sign zone data on-the-fly (middleware/dnssec).
*
Sign zone data on-the-fly (middleware/dnssec).
*
Loadbalancing of responses (middleware/loadbalance).
*
Load
balancing of responses (middleware/loadbalance).
*
Allow for zone transfers, i.e. act as a primary server (middleware/file).
*
Allow for zone transfers, i.e.
,
act as a primary server (middleware/file).
*
Caching (middleware/cache).
*
Caching (middleware/cache).
*
Health checking (middleware/health).
*
Health checking (middleware/health).
*
Use etcd as a backend, i.e. a 101.5% replacement for
*
Use etcd as a backend, i.e.
,
a 101.5% replacement for
[
SkyDNS
](
https://github.com/skynetservices/skydns
)
(
middleware/etcd
)
.
[
SkyDNS
](
https://github.com/skynetservices/skydns
)
(
middleware/etcd
)
.
*
Use k8s (kubernetes) as a backend (middleware/kubernetes).
*
Use k8s (kubernetes) as a backend (middleware/kubernetes).
*
Serve as a proxy to forward queries to some other (recursive) nameserver (middleware/proxy).
*
Serve as a proxy to forward queries to some other (recursive) nameserver (middleware/proxy).
*
Rewrite queries (
both
qtype, qclass and qname) (middleware/rewrite).
*
Rewrite queries (qtype, qclass and qname) (middleware/rewrite).
*
Provide metrics (by using Prometheus) (middleware/metrics).
*
Provide metrics (by using Prometheus) (middleware/metrics).
*
Provide Logging (middleware/log).
*
Provide Logging (middleware/log).
*
Has support for
the CH class:
`version.bind`
and friends (middleware/chaos).
*
Support
the CH class:
`version.bind`
and friends (middleware/chaos).
*
Profiling support (middleware/pprof).
*
Profiling support (middleware/pprof).
Each of the middlewares has a README.md of
their
own.
Each of the middlewares has a README.md of
its
own.
## Status
## Status
I'm using CoreDNS is my primary, authoritative, nameserver for my domains (
`miek.nl`
,
`atoom.net`
I'm using CoreDNS is my primary, authoritative, nameserver for my domains (
`miek.nl`
,
`atoom.net`
and a few others). CoreDNS should be stable enough to provide you with
a
good DNS(SEC) service.
and a few others). CoreDNS should be stable enough to provide you with good DNS(SEC) service.
There are still few
[
issues
](
https://github.com/miekg/coredns/issues
)
, and work is ongoing on making
There are still few
[
issues
](
https://github.com/miekg/coredns/issues
)
, and work is ongoing on making
things fast and reduce the memory usage.
things fast and
to
reduce the memory usage.
All in all, CoreDNS should be able to provide you with enough functionality to replace parts of
All in all, CoreDNS should be able to provide you with enough functionality to replace parts of
BIND9, Knot, NSD or PowerDNS and SkyDNS.
BIND
9, Knot, NSD or PowerDNS and SkyDNS.
Most documentation is in the source and some blog articles can be [found
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
here](https://miek.nl/tags/coredns/). If you do want to use CoreDNS in production, please let us
know and how we can help.
know and how we can help.
...
@@ -52,7 +52,7 @@ Caddyfile when I forked it).
...
@@ -52,7 +52,7 @@ Caddyfile when I forked it).
## Compilation
## Compilation
CoreDNS (as a servertype plugin for Caddy) has a dependency on Caddy - this is
*almost*
like
CoreDNS (as a servertype plugin for Caddy) has a dependency on Caddy - this is
*almost*
like
the normal Go dependencies, but with a small twist
,
caddy (the source) need to know that CoreDNS
the normal Go dependencies, but with a small twist
:
caddy (the source) need to know that CoreDNS
exists and for this we need to add 1 line
`_ "github.com/miekg/coredns/core"`
to file in caddy.
exists and for this we need to add 1 line
`_ "github.com/miekg/coredns/core"`
to file in caddy.
You have the source of CoreDNS, this should preferably be downloaded under your
`$GOPATH`
. Get all
You have the source of CoreDNS, this should preferably be downloaded under your
`$GOPATH`
. Get all
...
@@ -60,13 +60,13 @@ dependencies:
...
@@ -60,13 +60,13 @@ dependencies:
go get ./...
go get ./...
Then, execute
`go generate`
, t
his will patch Caddy to add CoreDNS (and remove the HTTP server
Then, execute
`go generate`
. T
his will patch Caddy to add CoreDNS (and remove the HTTP server
plugin), and then
`go build`
as you would normally do:
plugin), and then
`go build`
as you would normally do:
go generate
go generate
go build
go build
S
hould yield a
`coredns`
binary.
This s
hould yield a
`coredns`
binary.
## Examples
## Examples
...
@@ -82,10 +82,10 @@ Start a simple proxy, you'll need to be root to start listening on port 53.
...
@@ -82,10 +82,10 @@ Start a simple proxy, you'll need to be root to start listening on port 53.
~~~
~~~
Just start CoreDNS:
`./coredns`
.
Just start CoreDNS:
`./coredns`
.
And then just query on that port (53)
, t
he query should be forwarded to 8.8.8.8 and the response
And then just query on that port (53)
. T
he query should be forwarded to 8.8.8.8 and the response
will be returned. Each query should also show up in the log.
will be returned. Each query should also show up in the log.
Serve the (NSEC) DNSSEC
signed
`example.org`
on port 1053, errors and logging
to stdout. Allow zone
Serve the (NSEC) DNSSEC
-signed
`example.org`
on port 1053, with errors and logging sent
to stdout. Allow zone
transfers to everybody, but specically mention 1 IP address so that CoreDNS can send notifies to it.
transfers to everybody, but specically mention 1 IP address so that CoreDNS can send notifies to it.
~~~
txt
~~~
txt
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment