From a1ed0f4a46e053f04ef1f2c34eb3cde502cb7eb2 Mon Sep 17 00:00:00 2001 From: Elvis Souza Date: Mon, 20 Feb 2023 02:49:24 -0300 Subject: [PATCH] More details on doc (#290) * more details on doc * fixing docs generation * increase the text --- .github/workflows/docs.yml | 4 ++-- README.md | 18 +++++++++++++----- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 5ea7db6db..e15a35b0d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -2,8 +2,8 @@ name: Docs on: push: - tags: - - '*' + branches: + - master permissions: contents: write diff --git a/README.md b/README.md index e052415bd..62c7ce11c 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,27 @@ ### Main features -DPS is a end user(developers, Server Administrators) DNS server tool to develop systems with docker solving -docker containers hostnames: +DPS is a lightweight end user (Developers, Server Administrators) DNS server tool +which make it easy to develop in systems where one hostname can solve to different IPs based +on the configured environment, so you can: * Solve hostnames from local configuration database * Solve hostnames from docker containers using docker **hostname** option or **HOSTNAMES** env -* Solve hostnames from a list of configured DNS servers(as a proxy) if no answer of two above +* Solve hostnames from a list of configured remote DNS servers(as a proxy) if no answer of two above * Solve hostnames using wildcards * Graphic interface to Create/List/Update/Delete **A/CNAME** records * Solve host machine IP using `host.docker` hostname -* Access container by it’s container name / service name +* Access container by its container name / service name * Specify from which network solve container IP ![](https://i.imgur.com/aR9dl0O.png) -### Basic running it +### Basic running it + +You can run DPS as native binary downloading the latest [binaries releases][2] +or via docker looking at [Dockerhub images][3] + +Basic usecase using docker ```bash $ docker run --rm --hostname dns.mageddo \ @@ -55,3 +61,5 @@ Or via QR code ![](https://i.imgur.com/LmN7g2j.png) [1]: https://www.ietf.org/rfc/rfc1035.txt +[2]: https://github.com/mageddo/dns-proxy-server/releases +[3]: https://hub.docker.com/r/defreitas/dns-proxy-server