Skip to content
This repository was archived by the owner on Jan 18, 2023. It is now read-only.

Commit 5bf11d9

Browse files
authored
Update README.md
1 parent 072e5df commit 5bf11d9

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,27 @@ This is a fork of http://nip.io with some neat changes.
66

77
Dead simple wildcard DNS for any IP Address
88

9-
NIP.IO allows you to map any IP Address in the following DNS wildcard entries:
9+
nip.io allows you to map any IP Address in the following DNS wildcard entries:
1010

11+
It works with Dashes `-`, perfect for wildcard TLS certs:
1112
~~~
1213
10-0-0-1.nip.io maps to 10.0.0.1
13-
10.0.0.1.nip.io maps to 10.0.0.1
1414
app.10-0-0-1.nip.io maps to 10.0.0.1
15-
app.10.0.0.1.nip.io maps to 10.0.0.1
1615
customer1.app.10-0-0-1.nip.io maps to 10.0.0.1
17-
customer1.app.10.0.0.1.nip.io maps to 10.0.0.1
18-
otherapp.10-0-0-1.nip.io maps to 10.0.0.1
16+
~~~
1917

18+
As well as Dot `.`:
19+
~~~
20+
10.0.0.1.nip.io maps to 10.0.0.1
21+
app.10.0.0.1.nip.io maps to 10.0.0.1
22+
customer1.app.10.0.0.1.nip.io maps to 10.0.0.1
2023
NIP.IO maps <anything>.<IP Address with dashes or dots>.nip.io to the corresponding <IP Address>, even 127-0-0-1.nip.io maps to 127.0.0.1
2124
~~~
2225

26+
See https://github.com/resmo/nip.io/blob/master/src/backend.conf.example for an example config
27+
28+
**Hint**: See the static CNAME `_acme-challenge=xyz.auth.example.com.` in the example, use it with https://github.com/joohoi/acme-dns for free Let's Encrypt TLS certs.
29+
2330
## INSTALL
2431

2532
### As docker container
@@ -31,7 +38,7 @@ docker build -t nip.io .
3138

3239
Run the container:
3340
~~~
34-
docker run -d -p 0.0.0.0:53:53/tcp -p 0.0.0.0:53:53/udp --name nip.io nip.io
41+
docker run -d -p 0.0.0.0:53:53/tcp -p 0.0.0.0:53:53/udp -v /data/backend.conf:/usr/local/bin/backend.conf --name nip.io nip.io
3542
~~~
3643

3744
See the logs:

0 commit comments

Comments
 (0)