Skip to content

Commit 1eec1df

Browse files
authored
Merge pull request mageddo#606 from mageddo/readme-docs
updating readme running it examples
2 parents ea58a4b + 41aea3f commit 1eec1df

File tree

2 files changed

+40
-14
lines changed

2 files changed

+40
-14
lines changed

README.md

Lines changed: 39 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,31 +22,57 @@ Checkout the [full list of features][4] with examples
2222
### Basic running it
2323

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

2728
Basic running it on Linux or Mac
29+
2830
```bash
29-
sudo ./dns-proxy-server
31+
sudo ./dns-proxy-server --server-port 5555
3032
```
3133

32-
Then you can solve from pre-configured entries (conf/config.json):
34+
Solving docker containers:
3335
```bash
34-
$ ping dps-sample.dev
35-
PING dps-sample.dev (192.168.0.254) 56(84) bytes of data.
36+
$ docker run --rm --hostname nginx.dev nginx
37+
38+
$ nslookup -po=5555 nginx.dev 127.0.0.1
39+
172.17.0.3
3640
```
3741

38-
Also solve Docker containers:
42+
Solving from pre-configured entries (conf/config.json):
3943
```bash
40-
$ docker run --rm --hostname nginx.dev nginx
44+
$ nslookup -po=5555 dps-sample.dev 127.0.0.1
45+
192.168.0.254
46+
```
47+
48+
Solving from Internet
49+
```bash
50+
$ nslookup -po=5555 google.com 127.0.0.1
51+
142.250.79.174
52+
```
53+
54+
Solving stub hostnames like nip.io or sslip.io
55+
```bash
56+
$ nslookup -po=5555 machine-1.192.168.0.1.stub 127.0.0.1
57+
192.168.0.1
58+
```
59+
60+
Solving host machine IP
61+
```bash
62+
$ nslookup -po=5555 host.docker 127.0.0.1
63+
172.22.230.67
64+
```
65+
66+
Solving all subdomains to a specific docker container
67+
68+
```bash
69+
$ docker run --rm --hostname .nginx.dev nginx
4170

42-
$ ping nginx.dev
43-
PING nginx.dev (172.17.0.4) 56(84) bytes of data.
44-
64 bytes from 172.17.0.4 (172.17.0.4): icmp_seq=1 ttl=64 time=0.043 ms
45-
64 bytes from 172.17.0.4 (172.17.0.4): icmp_seq=2 ttl=64 time=0.022 ms
71+
$ nslookup -po=5555 site1.nginx.dev 127.0.0.1
72+
172.17.0.3
4673
```
4774

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

5177
### Documents
5278
* [Full documentation](http://mageddo.github.io/dns-proxy-server/)

RELEASE-NOTES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## 3.32.3
2-
* Ignoring containers which fails to inspect. #599
2+
* Ignoring containers which fails to inspect, credits to @defung . #599
33

44
## 3.32.2
55
* Exposing Stub Solver domain config, see the docs. #545

0 commit comments

Comments
 (0)