Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Alessio Garofalo committed Sep 18, 2017
1 parent 61691fc commit 1013263
Showing 1 changed file with 9 additions and 65 deletions.
74 changes: 9 additions & 65 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![Circle CI](https://circleci.com/gh/einyx/docker-bind.svg?style=shield)](https://circleci.com/gh/sameersbn/docker-bind) [![Docker Repository on Quay.io](https://quay.io/repository/sameersbn/bind/status "Docker Repository on Quay.io")](https://quay.io/repository/sameersbn/bind)
[![Docker Repository on Quay.io](https://quay.io/repository/sameersbn/bind/status "Docker Repository on Quay.io")](https://quay.io/repository/sameersbn/bind)

# einyx/bind:0.1
# einyx/bind:0.2

- [Introduction](#introduction)
- [Contributing](#contributing)
Expand All @@ -16,7 +16,7 @@

# Introduction

`Dockerfile` to create a [Docker](https://www.docker.com/) container image for [BIND](https://www.isc.org/downloads/bind/) DNS server bundled with the [Webmin](http:https://www.webmin.com/) interface.
`Dockerfile` to create a [Docker](https://www.docker.com/) container image for [BIND](https://www.isc.org/downloads/bind/) DNS server.

BIND is open source software that implements the Domain Name System (DNS) protocols for the Internet. It is a reference implementation of those protocols, but it is also production-grade software, suitable for use in high-volume and high-reliability applications.

Expand All @@ -26,30 +26,22 @@ If you find this image useful here's how you can help:

- Send a pull request with your awesome features and bug fixes
- Help users resolve their [issues](../../issues?q=is%3Aopen+is%3Aissue).
- Support the development of this image with a [donation](http:https://www.damagehead.com/donate/)
- Support the development of this image with a [donation](BTC: 1NXrjqfJ753X8pxsSw1NWL6GZYAxUvSuzB)

## Issues

Before reporting your issue please try updating Docker to the latest version and check if it resolves the issue. Refer to the Docker [installation guide](https://docs.docker.com/installation) for instructions.

SELinux users should try disabling SELinux using the command `setenforce 0` to see if it resolves the issue.

If the above recommendations do not help then [report your issue](../../issues/new) along with the following information:

- Output of the `docker version` and `docker info` commands
- The `docker run` command or `docker-compose.yml` used to start the image. Mask out the sensitive bits.
- Please state if you are using [Boot2Docker](http:https://www.boot2docker.io), [VirtualBox](https://www.virtualbox.org), etc.
- Scaleway (Online.net) is known to drop SOA requests randomly.

# Getting started

## Installation

Automated builds of the image are available on [Dockerhub](https://hub.docker.com/r/einyx/bind) and is the recommended method of installation.
Automated builds of the image are available on [Dockerhub](https://hub.docker.com/r/einyx/docker-bind) and is the recommended method of installation.

> **Note**: Builds are also available on [Quay.io](https://quay.io/repository/einyx/bind)
> **Note**: Builds are also available on [Quay.io](https://quay.io/repository/einyx/kubernetes-bind)
```bash
docker pull einyx/bind:0.1
docker pull einyx/bind:0.2
```

Alternatively you can build the image yourself.
Expand All @@ -66,17 +58,9 @@ Start BIND using:
docker run --name bind -d --restart=always \
--publish 53:53/tcp --publish 53:53/udp --publish 10000:10000/tcp \
--volume /srv/docker/bind:/data \
einyx/bind:0.1
einyx/bind:0.2
```

*Alternatively, you can use the sample [docker-compose.yml](docker-compose.yml) file to start the container using [Docker Compose](https://docs.docker.com/compose/)*

When the container is started the [Webmin](http:https://www.webmin.com/) service is also started and is accessible from the web browser at https://localhost:10000. Login to Webmin with the username `root` and password `password`. Specify `--env ROOT_PASSWORD=secretpassword` on the `docker run` command to set a password of your choosing.

The launch of Webmin can be disabled by adding `--env WEBMIN_ENABLED=false` to the `docker run` command. Note that the `ROOT_PASSWORD` parameter has no effect when the launch of Webmin is disabled.

Read the blog post [Deploying a DNS Server using Docker](http:https://www.damagehead.com/blog/2015/04/28/deploying-a-dns-server-using-docker/) for an example use case.

## Command-line arguments

You can customize the launch command of BIND server by specifying arguments to `named` on the `docker run` command. For example the following command prints the help menu of `named` command:
Expand All @@ -100,43 +84,3 @@ SELinux users should update the security context of the host mountpoint so that
mkdir -p /srv/docker/bind
chcon -Rt svirt_sandbox_file_t /srv/docker/bind
```

# Maintenance

## Upgrading

To upgrade to newer releases:

1. Download the updated Docker image:

```bash
docker pull einyx/bind:0.1
```

2. Stop the currently running image:

```bash
docker stop bind
```

3. Remove the stopped container

```bash
docker rm -v bind
```

4. Start the updated image

```bash
docker run -name bind -d \
[OPTIONS] \
einyx/bind:0.1
```

## Shell Access

For debugging and maintenance purposes you may want access the containers shell. If you are using Docker version `1.3.0` or higher you can access a running containers shell by starting `bash` using `docker exec`:

```bash
docker exec -it bind bash
```

0 comments on commit 1013263

Please sign in to comment.