varl/pubip
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Viktor Varland 2016-04-05 19:16:04 +02:00
parent 51d3a9d0fe
commit fe37e9ecae
1 changed files with 16 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -5,17 +5,30 @@ Simple dynamic DNS resolver which works with
[Tomato](http://www.polarcloud.com/tomato) and requires [Python [Tomato](http://www.polarcloud.com/tomato) and requires [Python
3](http://python.org). 3](http://python.org).
## `/show/:user`: ## Setup in Tomato
0. In the left menu under `Basic -> DDNS` set "auto-refresh every" to e.g. 1 days.
0. In the `Service` dropdown choose: `Custom URL`.
0. Add URL to where you have this service running: `http://YOUR_SERVER.TLD/update/YOUR_KEY/@IP`.
0. Check `Force next update`.
0. Hit `Save`.
0. Verify `Last IP Address` and `Last Result`
0. Point your browser to `http://YOUR_SERVER.TLD/show/YOUR_KEY` to see what `YOUR_KEY` is bound to.
0. Or check if redirects works as intended with `http://YOUR_SERVER.TLD/go/YOUR_KEY/PORT`.
## API
### `/show/:user`:
Shows the current IP that is set for key `:user`. Shows the current IP that is set for key `:user`.
## `/update/:user/:ip`: ### `/update/:user/:ip`:
Updates the current IP. Updates the current IP.
`:ip` must match the request client address. `:ip` must match the request client address.
## `/go/:user/:port`: ### `/go/:user/:port`:
This redirects you to whatever IP that `:user` is set to along with `:port`. This redirects you to whatever IP that `:user` is set to along with `:port`.