Skip to content

Commit 56fab95

Browse files
cytopiacytopia
authored
Merge pull request #58 from cytopia/docs
Update README
2 parents 6dd96f6 + 4cbe6ac commit 56fab95

1 file changed

Lines changed: 51 additions & 37 deletions

File tree

‎README.md‎

Lines changed: 51 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,59 @@
11
# Bind Docker
22

33

4+
[![Tag](https://img.shields.io/github/tag/cytopia/docker-bind.svg)](https://github.com/cytopia/docker-bind/releases)
45
[![lint](https://github.com/cytopia/docker-bind/workflows/lint/badge.svg)](https://github.com/cytopia/docker-bind/actions?query=workflow%3Alint)
56
[![build](https://github.com/cytopia/docker-bind/workflows/build/badge.svg)](https://github.com/cytopia/docker-bind/actions?query=workflow%3Abuild)
67
[![nightly](https://github.com/cytopia/docker-bind/workflows/nightly/badge.svg)](https://github.com/cytopia/docker-bind/actions?query=workflow%3Anightly)
7-
8-
[![Tag](https://img.shields.io/github/tag/cytopia/docker-bind.svg)](https://github.com/cytopia/docker-bind/releases)
98
[![Gitter](https://badges.gitter.im/cytopia/Lobby.svg)](https://gitter.im/cytopia/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
109
[![Discourse](https://img.shields.io/discourse/https/devilbox.discourse.group/status.svg?colorB=%234CB697)](https://devilbox.discourse.group)
11-
[![](https://images.microbadger.com/badges/version/cytopia/bind.svg)](https://microbadger.com/images/cytopia/bind "bind")
12-
[![](https://images.microbadger.com/badges/image/cytopia/bind.svg)](https://microbadger.com/images/cytopia/bind "bind")
1310
[![License](https://img.shields.io/badge/license-MIT-%233DA639.svg)](https://opensource.org/licenses/MIT)
1411

12+
Bind caching DNS server based on Alpine and Debian slim with support for DNS forwarders, infinite wild-card DNS, infinite extra hosts, reverse DNS, DNSSEC timing settings and others.
13+
14+
[![](https://img.shields.io/docker/pulls/cytopia/bind.svg)](https://hub.docker.com/r/cytopia/bind)
15+
[![Docker](https://badgen.net/badge/icon/:latest?icon=docker&label=cytopia/bind)](https://hub.docker.com/r/cytopia/bind)
16+
1517
**Available Architectures:** `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6`, `ppc64le`, `s390x`, `mips64le`
1618

17-
----
19+
| Upstream Project |
20+
|------------------|
21+
| <a title="Devilbox" href="https://github.com/cytopia/devilbox" ><img title="Devilbox" height="82px" src="https://raw.githubusercontent.com/devilbox/artwork/master/submissions_banner/cytopia/01/png/banner_256_trans.png" /></a> |
22+
1823

19-
Bind caching DNS server based on Debian slim with support for DNS forwarders, infinite wild-card DNS, infinite extra hosts, reverse DNS, DNSSEC timing settings and others.
24+
## :whale: Available Docker tags
2025

26+
#### Rolling Releases
2127

22-
| Docker Hub | Upstream Project |
23-
|------------|------------------|
24-
| <a href="https://hub.docker.com/r/cytopia/bind"><img height="82px" src="http://dockeri.co/image/cytopia/bind" /></a> | <a href="https://github.com/cytopia/devilbox" ><img height="82px" src="https://raw.githubusercontent.com/devilbox/artwork/master/submissions_banner/cytopia/01/png/banner_256_trans.png" /></a> |
28+
The following Docker image tags are rolling releases and are built and updated every night.
29+
30+
[![nightly](https://github.com/cytopia/docker-bind/workflows/nightly/badge.svg)](https://github.com/cytopia/docker-bind/actions?query=workflow%3Anightly)
2531

26-
## Available Docker tags
32+
| Debian stable | Alpine |
33+
|---------------|--------|
34+
| [`latest`](Dockerfiles/Dockerfile.latest) [`stable`](Dockerfiles/Dockerfile.stable)<br/>[`latest-<latest-git-tag>`](Dockerfiles/Dockerfile.latest) [`stable-<latest-git-tag>`](Dockerfiles/Dockerfile.stable) | [`alpine`](Dockerfiles/Dockerfile.alpine)<br/>[`alpine-<latest-git-tag>`](Dockerfiles/Dockerfile.alpine) |
2735

28-
| Docker Tag | Description |
29-
|--------------------------------|--------------------------------------------------------------|
30-
| `latest` | Latest Debian stable image (default) |
31-
| `stable` | Latest Debian stable image |
32-
| `alpine` | Latest Alpine image |
33-
| | |
34-
| `[0-9]\.[0-9]+` | Git tagged Debian stable image. E.g: `0.53` |
35-
| `stable-[0-9]\.[0-9]+` | Git tagged Debian stable image. E.g: `stable-0.53` |
36-
| `alpine-[0-9]\.[0-9]+` | Git tagged Alpine image. E.g: `alpine-0.53` |
37-
| | |
38-
| `release-[0-9]\.[0-9]+` | Git branch Debian stable image. E.g: `release-0.53` |
39-
| `stable-release-[0-9]\.[0-9]+` | Git branch Debian stable image. E.g: `stable-release-0.53` |
40-
| `alpine-release-[0-9]\.[0-9]+` | Git branch Alpine image. E.g: `alpine-release-0.53` |
36+
> :information_source: Where `<latest-git-tag>` refers to the latest git tag from this repository.<br/>
37+
> :information_source: Note: Only the latest git tag is build nightly, all others remain unchaned.
4138
4239

40+
#### Point in time releases
41+
42+
The following Docker image tags are built once and can be used for reproducible builds. Its version never changes so you will have to update tags in your pipelines from time to time in order to stay up-to-date.
43+
44+
[![build](https://github.com/cytopia/docker-bind/workflows/build/badge.svg)](https://github.com/cytopia/docker-bind/actions?query=workflow%3Abuild)
45+
46+
| Debian stable | Alpine |
47+
|---------------|--------|
48+
| [`latest-<git-tag>`](Dockerfiles/Dockerfile.latest) [`stable-<git-tag>`](Dockerfiles/Dockerfile.stable) | [`alpine-<git-tag>`](Dockerfiles/Dockerfile.alpine) |
49+
50+
> :information_source: Where `<git-tag>` refers to the chosen git tag from this repository.<br/>
51+
4352
----
4453

4554
**Table of Contents**
4655

47-
1. [Environmental variables](#environmental-variables)
56+
1. [Environmental variables](#capital_abcd-environmental-variables)
4857
1. [Required environmental variables](#required-environmental-variables)
4958
2. [Optional environmental variables](#optional-environmental-variables)
5059
1. [DEBUG_ENTRYPOINT](#debug_entrypoint)
@@ -62,9 +71,9 @@ Bind caching DNS server based on Debian slim with support for DNS forwarders, in
6271
13. [MAX_CACHE_TIME](#max_cache_time)
6372
14. [ALLOW_QUERY](#allow_query)
6473
15. [ALLOW_RECURSION](#allow_recursion)
65-
2. [Default mountpoints](#default-mountpoints)
66-
3. [Default ports](#default-ports)
67-
4. [Examples](#examples)
74+
2. [Default mountpoints](#open_file_folder-default-mount-points)
75+
3. [Default ports](#calling-default-ports)
76+
4. [Examples](#information_source-examples)
6877
1. [Default run](#default-run)
6978
2. [Wildcard domain](#wildcard-domain)
7079
3. [Wildcard subdomain](#wildcard-subdomain)
@@ -73,13 +82,14 @@ Bind caching DNS server based on Debian slim with support for DNS forwarders, in
7382
6. [Wildcard TLD and DNS resolver](#wildcard-tld-and-dns-resolver)
7483
7. [Wildcard TLD, DNS resolver and extra hosts](#wildcard-tld-dns-resolver-and-extra-hosts)
7584
8. [Extra hosts, DNS resolver, allow query, and allow recursion](#extra-hosts-dns-resolver-allow-query-and-allow-recursion)
76-
5. [Host integration](#host-integration)
77-
6. [Support](#support)
78-
7. [License](#license)
85+
5. [Host integration](#wrench-host-integration)
86+
6. [Support](#coffee-support)
87+
7. [Articles](#page_with_curl-articles)
88+
8. [License](#page_facing_up-license)
7989

8090
---
8191

82-
## Environmental variables
92+
## :capital_abcd: Environmental variables
8393

8494
### Required environmental variables
8595

@@ -265,20 +275,20 @@ ALLOW_RECURSION='any'
265275
ALLOW_RECURSION='192.168.1.0/24,127.0.0.1'
266276
```
267277

268-
## Default mount points
278+
## :open_file_folder: Default mount points
269279

270280
- None
271281

272282

273-
## Default ports
283+
## :calling: Default ports
274284

275285
| Docker | Description |
276286
|--------|--------------|
277287
| 53 | DNS Resolver |
278288
| 53/udp | DNS Resolver |
279289

280290

281-
## Examples
291+
## :information_source: Examples
282292

283293
The following examples start the container in foreground and use `-i`, so you can easily stop
284294
it by pressing `<Ctrl> + c`. For a production run, you would rather use `-d` to send it to the
@@ -404,7 +414,7 @@ $ docker run -i \
404414
-t cytopia/bind
405415
```
406416

407-
## Host integration
417+
## :wrench: Host integration
408418

409419
You can run this DNS container locally without having to worry to affect any corporate DNS server
410420
that are given to you via DHCP.
@@ -429,7 +439,7 @@ If `cytopia/bind` is not running, it does not affect the name resolution, becaus
429439
have entries in `/etc/resolv.conf`.
430440

431441

432-
## Support
442+
## :coffee: Support
433443

434444
Get support here
435445

@@ -461,8 +471,12 @@ Get support here
461471
</table>
462472

463473

474+
## :page_with_curl: Articles
475+
476+
* [Serving Bind DNS in Kubernetes](https://medium.com/swlh/serving-bind-dns-in-kubernetes-8639fce37448)
477+
464478

465-
## License
479+
## :page_facing_up: License
466480

467481
**[MIT License](LICENSE.md)**
468482

0 commit comments

Comments
 (0)