Skip to content
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.

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

updating readme running it examples #606

Merged
merged 2 commits into from
Nov 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
52 changes: 39 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,31 +22,57 @@ Checkout the [full list of features][4] with examples
### Basic running it

You can run DPS as native binary downloading the latest [binaries releases][2]
or via docker looking at [Dockerhub images][3].
or via docker looking at [Dockerhub images][3]. See [complete running it][5] documentation for running on
Mac, Windows, Docker, etc.

Basic running it on Linux or Mac

```bash
sudo ./dns-proxy-server
sudo ./dns-proxy-server --server-port 5555
```

Then you can solve from pre-configured entries (conf/config.json):
Solving docker containers:
```bash
$ ping dps-sample.dev
PING dps-sample.dev (192.168.0.254) 56(84) bytes of data.
$ docker run --rm --hostname nginx.dev nginx

$ nslookup -po=5555 nginx.dev 127.0.0.1
172.17.0.3
```

Also solve Docker containers:
Solving from pre-configured entries (conf/config.json):
```bash
$ docker run --rm --hostname nginx.dev nginx
$ nslookup -po=5555 dps-sample.dev 127.0.0.1
192.168.0.254
```

Solving from Internet
```bash
$ nslookup -po=5555 google.com 127.0.0.1
142.250.79.174
```

Solving stub hostnames like nip.io or sslip.io
```bash
$ nslookup -po=5555 machine-1.192.168.0.1.stub 127.0.0.1
192.168.0.1
```

Solving host machine IP
```bash
$ nslookup -po=5555 host.docker 127.0.0.1
172.22.230.67
```

Solving all subdomains to a specific docker container

```bash
$ docker run --rm --hostname .nginx.dev nginx

$ ping nginx.dev
PING nginx.dev (172.17.0.4) 56(84) bytes of data.
64 bytes from 172.17.0.4 (172.17.0.4): icmp_seq=1 ttl=64 time=0.043 ms
64 bytes from 172.17.0.4 (172.17.0.4): icmp_seq=2 ttl=64 time=0.022 ms
$ nslookup -po=5555 site1.nginx.dev 127.0.0.1
172.17.0.3
```

See [complete running it][5] documentation for running on Mac, Windows, Docker, etc.
also check the [samples][9] to learn by pratice.
Check more [samples][9] to learn by practice.

### Documents
* [Full documentation](http://mageddo.github.io/dns-proxy-server/)
Expand Down
2 changes: 1 addition & 1 deletion RELEASE-NOTES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## 3.32.3
* Ignoring containers which fails to inspect. #599
* Ignoring containers which fails to inspect, credits to @defung . #599

## 3.32.2
* Exposing Stub Solver domain config, see the docs. #545
Expand Down
Loading