Skip to content

Update README #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 2, 2022
Merged

Update README #58

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3ec3392
Update README
cytopia Dec 2, 2022
d013025
Fix anchor links
cytopia Dec 2, 2022
4cbe6ac
Fix badges
cytopia Dec 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 51 additions & 37 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,50 +1,59 @@
# Bind Docker


[![Tag](https://img.shields.io/github/tag/cytopia/docker-bind.svg)](https://github.com/cytopia/docker-bind/releases)
[![lint](https://github.com/cytopia/docker-bind/workflows/lint/badge.svg)](https://github.com/cytopia/docker-bind/actions?query=workflow%3Alint)
[![build](https://github.com/cytopia/docker-bind/workflows/build/badge.svg)](https://github.com/cytopia/docker-bind/actions?query=workflow%3Abuild)
[![nightly](https://github.com/cytopia/docker-bind/workflows/nightly/badge.svg)](https://github.com/cytopia/docker-bind/actions?query=workflow%3Anightly)

[![Tag](https://img.shields.io/github/tag/cytopia/docker-bind.svg)](https://github.com/cytopia/docker-bind/releases)
[![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)
[![Discourse](https://img.shields.io/discourse/https/devilbox.discourse.group/status.svg?colorB=%234CB697)](https://devilbox.discourse.group)
[![](https://images.microbadger.com/badges/version/cytopia/bind.svg)](https://microbadger.com/images/cytopia/bind "bind")
[![](https://images.microbadger.com/badges/image/cytopia/bind.svg)](https://microbadger.com/images/cytopia/bind "bind")
[![License](https://img.shields.io/badge/license-MIT-%233DA639.svg)](https://opensource.org/licenses/MIT)

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.

[![](https://img.shields.io/docker/pulls/cytopia/bind.svg)](https://hub.docker.com/r/cytopia/bind)
[![Docker](https://badgen.net/badge/icon/:latest?icon=docker&label=cytopia/bind)](https://hub.docker.com/r/cytopia/bind)

**Available Architectures:** `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6`, `ppc64le`, `s390x`, `mips64le`

----
| Upstream Project |
|------------------|
| <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> |


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.
## :whale: Available Docker tags

#### Rolling Releases

| Docker Hub | Upstream Project |
|------------|------------------|
| <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> |
The following Docker image tags are rolling releases and are built and updated every night.

[![nightly](https://github.com/cytopia/docker-bind/workflows/nightly/badge.svg)](https://github.com/cytopia/docker-bind/actions?query=workflow%3Anightly)

## Available Docker tags
| Debian stable | Alpine |
|---------------|--------|
| [`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) |

| Docker Tag | Description |
|--------------------------------|--------------------------------------------------------------|
| `latest` | Latest Debian stable image (default) |
| `stable` | Latest Debian stable image |
| `alpine` | Latest Alpine image |
| | |
| `[0-9]\.[0-9]+` | Git tagged Debian stable image. E.g: `0.53` |
| `stable-[0-9]\.[0-9]+` | Git tagged Debian stable image. E.g: `stable-0.53` |
| `alpine-[0-9]\.[0-9]+` | Git tagged Alpine image. E.g: `alpine-0.53` |
| | |
| `release-[0-9]\.[0-9]+` | Git branch Debian stable image. E.g: `release-0.53` |
| `stable-release-[0-9]\.[0-9]+` | Git branch Debian stable image. E.g: `stable-release-0.53` |
| `alpine-release-[0-9]\.[0-9]+` | Git branch Alpine image. E.g: `alpine-release-0.53` |
> :information_source: Where `<latest-git-tag>` refers to the latest git tag from this repository.<br/>
> :information_source: Note: Only the latest git tag is build nightly, all others remain unchaned.


#### Point in time releases

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.

[![build](https://github.com/cytopia/docker-bind/workflows/build/badge.svg)](https://github.com/cytopia/docker-bind/actions?query=workflow%3Abuild)

| Debian stable | Alpine |
|---------------|--------|
| [`latest-<git-tag>`](Dockerfiles/Dockerfile.latest) [`stable-<git-tag>`](Dockerfiles/Dockerfile.stable) | [`alpine-<git-tag>`](Dockerfiles/Dockerfile.alpine) |

> :information_source: Where `<git-tag>` refers to the chosen git tag from this repository.<br/>

----

**Table of Contents**

1. [Environmental variables](#environmental-variables)
1. [Environmental variables](#capital_abcd-environmental-variables)
1. [Required environmental variables](#required-environmental-variables)
2. [Optional environmental variables](#optional-environmental-variables)
1. [DEBUG_ENTRYPOINT](#debug_entrypoint)
Expand All @@ -62,9 +71,9 @@ Bind caching DNS server based on Debian slim with support for DNS forwarders, in
13. [MAX_CACHE_TIME](#max_cache_time)
14. [ALLOW_QUERY](#allow_query)
15. [ALLOW_RECURSION](#allow_recursion)
2. [Default mountpoints](#default-mountpoints)
3. [Default ports](#default-ports)
4. [Examples](#examples)
2. [Default mountpoints](#open_file_folder-default-mount-points)
3. [Default ports](#calling-default-ports)
4. [Examples](#information_source-examples)
1. [Default run](#default-run)
2. [Wildcard domain](#wildcard-domain)
3. [Wildcard subdomain](#wildcard-subdomain)
Expand All @@ -73,13 +82,14 @@ Bind caching DNS server based on Debian slim with support for DNS forwarders, in
6. [Wildcard TLD and DNS resolver](#wildcard-tld-and-dns-resolver)
7. [Wildcard TLD, DNS resolver and extra hosts](#wildcard-tld-dns-resolver-and-extra-hosts)
8. [Extra hosts, DNS resolver, allow query, and allow recursion](#extra-hosts-dns-resolver-allow-query-and-allow-recursion)
5. [Host integration](#host-integration)
6. [Support](#support)
7. [License](#license)
5. [Host integration](#wrench-host-integration)
6. [Support](#coffee-support)
7. [Articles](#page_with_curl-articles)
8. [License](#page_facing_up-license)

---

## Environmental variables
## :capital_abcd: Environmental variables

### Required environmental variables

Expand Down Expand Up @@ -265,20 +275,20 @@ ALLOW_RECURSION='any'
ALLOW_RECURSION='192.168.1.0/24,127.0.0.1'
```

## Default mount points
## :open_file_folder: Default mount points

- None


## Default ports
## :calling: Default ports

| Docker | Description |
|--------|--------------|
| 53 | DNS Resolver |
| 53/udp | DNS Resolver |


## Examples
## :information_source: Examples

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

## Host integration
## :wrench: Host integration

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


## Support
## :coffee: Support

Get support here

Expand Down Expand Up @@ -461,8 +471,12 @@ Get support here
</table>


## :page_with_curl: Articles

* [Serving Bind DNS in Kubernetes](https://medium.com/swlh/serving-bind-dns-in-kubernetes-8639fce37448)


## License
## :page_facing_up: License

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

Expand Down