|
| 1 | + |
| 2 | + |
| 3 | +The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring auto-update on startup, easy user mapping and community support. Find us for support at: |
| 4 | +* [forum.linuxserver.io](https://forum.linuxserver.io) |
| 5 | +* [IRC](https://www.linuxserver.io/index.php/irc/) on freenode at `#linuxserver.io` |
| 6 | +* [Podcast](https://www.linuxserver.io/index.php/category/podcast/) covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! |
| 7 | + |
| 8 | +# linuxserver/duckdns |
| 9 | + |
| 10 | +Duck DNS is a free service which will point a DNS (sub domains of duckdns.org) to an IP of your choice. The service is completely free, and doesn't require reactivation or forum posts to maintain its existence. |
| 11 | + |
| 12 | +## Usage |
| 13 | + |
| 14 | +``` |
| 15 | +docker create \ |
| 16 | + --name=DuckDNS \ |
| 17 | + -e PGID=<gid> -e PUID=<uid> \ |
| 18 | + -e SUBDOMAINS=<subdomains> \ |
| 19 | + -e TOKEN=<token> \ |
| 20 | + linuxserver/duckdns |
| 21 | +``` |
| 22 | + |
| 23 | +**Parameters** |
| 24 | + |
| 25 | +* `-e PGID` for GroupID - see below for explanation |
| 26 | +* `-e PUID` for UserID - see below for explanation |
| 27 | +* `-e SUBDOMAINS` for subdomains - multiple subdomains allowed, comma separated, no spaces |
| 28 | +* `-e TOKEN` for DuckDNS token |
| 29 | + |
| 30 | + |
| 31 | +### User / Group Identifiers |
| 32 | + |
| 33 | +Sometimes when using data volumes (`-v` flags) permissions issues can arise between the host OS and the container. We avoid this issue by allowing you to specify the user `PUID` and group `PGID`. Ensure the data volume directory on the host is owned by the same user you specify and it will "just work" ™. |
| 34 | + |
| 35 | +In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: |
| 36 | + |
| 37 | +``` |
| 38 | + $ id <dockeruser> |
| 39 | + uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) |
| 40 | +``` |
| 41 | + |
| 42 | +## Setting up the application |
| 43 | + |
| 44 | +First, go to www.duckdns.org, register your subdomain and retrieve your token |
| 45 | +Then run the docker create command above with your subdomain(s) and token |
| 46 | +It will update your IP with the DuckDNS service every 5 minutes |
| 47 | + |
| 48 | + |
| 49 | +## Updates |
| 50 | + |
| 51 | +* Shell access whilst the container is running: `docker exec -it DuckDNS /bin/bash` |
| 52 | +* Upgrade to the latest version: `docker restart DuckDNS` |
| 53 | +* To monitor the logs of the container in realtime: `docker logs -f DuckDNS` |
| 54 | + |
| 55 | +## Versions |
| 56 | + |
| 57 | ++ **25.03.2016:** Initial release |
0 commit comments