Skip to content

Commit

Permalink
More details on doc (#290)
Browse files Browse the repository at this point in the history
* more details on doc

* fixing docs generation

* increase the text
  • Loading branch information
mageddo authored Feb 20, 2023
1 parent b5e3b4d commit a1ed0f4
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ name: Docs

on:
push:
tags:
- '*'
branches:
- master

permissions:
contents: write
Expand Down
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down Expand Up @@ -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

0 comments on commit a1ed0f4

Please sign in to comment.