README
¶
coredns-docker
A CoreDNS plugin that serves DNS records for containers running on the local Docker daemon.
Installation
Install from a published release on the GitHub releases page:
# Linux amd64 — pick the binary that matches your platform/arch
curl -fsSL -o coredns-docker \
https://github.com/dokku/coredns-docker/releases/latest/download/coredns-docker-linux-amd64
chmod +x coredns-docker
sudo mv coredns-docker /usr/local/bin/
Or build a single binary from source (requires Go):
make build-local
This produces ./coredns-docker-local in the repository root. See docs/installation.md for Debian packages, cross-platform builds, and the Docker image.
Basic usage
Create a minimal Corefile that serves the docker. zone on port 1053:
docker:1053 {
docker {
zone docker.
}
}
Start CoreDNS with that Corefile:
coredns-docker -conf Corefile
Start any Docker container and query it by name:
docker run -d --name web nginx
dig @127.0.0.1 -p 1053 web.docker +short
# → 172.17.0.2
The plugin watches Docker events, so starting, stopping, or restarting containers updates the available names with no need to restart CoreDNS.
Documentation
- Getting Started -- install, first Corefile, first query
- Installation -- release binaries, Debian packages, source builds, and Docker image
- DNS Basics -- a short primer on zones, A/AAAA, SRV, TXT, CNAME, PTR records, and TTLs
- Configuration -- every Corefile option, stale mode, reverse zones, and the synthetic SOA/NS
- Docker Labels -- hostname, cname, txt, srv, and wildcard labels
- Metrics -- every Prometheus metric the plugin exposes
- Testing -- unit, integration, and end-to-end test targets
- Linux with systemd -- route
docker.queries viasystemd-resolvedand run CoreDNS as a service - macOS with /etc/resolver -- route
docker.queries via the macOS resolver - Examples -- runnable
docker compose+Corefilesetups for every feature
License
Documentation
¶
Index ¶
Constants ¶
const DefaultTTL = uint32(30)
DefaultTTL is the default TTL for DNS records.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ContainerInspector ¶
type ContainerInspector interface {
ContainerInspect(ctx context.Context, containerID string) (container.InspectResponse, error)
}
ContainerInspector is an interface for inspecting containers.
type Docker ¶
Docker is a plugin that serves records for Docker containers
type GenerateRecordsInput ¶
type GenerateRecordsInput struct {
// Client is the Docker client to use.
Inspector ContainerInspector
// Containers is the list of containers to generate records for.
Containers []container.Summary
// Zones is the list of domains to generate records for.
Zones []string
// LabelPrefix is the label prefix to generate records for.
LabelPrefix string
// Networks is the list of networks to generate records for.
Networks []string
// HostMode enables host-bound IP/port resolution instead of container IPs.
// When true, A/AAAA and SRV records are derived from each container's
// published host port bindings (NetworkSettings.Ports).
HostMode bool
// HostModePTR enables PTR record emission while HostMode is active.
// Off by default because multiple containers may share a host IP
// (especially the loopback fallback), making reverse lookups noisy.
HostModePTR bool
}
GenerateRecordsInput is the input for the generateRecords function.
Source Files