2019-03-30 20:32:40 +00:00
# [linuxserver/duckdns](https://github.com/linuxserver/docker-duckdns)
2019-02-09 20:33:32 +00:00
2019-08-31 19:32:58 +00:00
[![GitHub Release ](https://img.shields.io/github/release/linuxserver/docker-duckdns.svg?style=flat-square&color=E68523 )](https://github.com/linuxserver/docker-duckdns/releases)
[![MicroBadger Layers ](https://img.shields.io/microbadger/layers/linuxserver/duckdns.svg?style=flat-square&color=E68523 )](https://microbadger.com/images/linuxserver/duckdns "Get your own version badge on microbadger.com")
[![MicroBadger Size ](https://img.shields.io/microbadger/image-size/linuxserver/duckdns.svg?style=flat-square&color=E68523 )](https://microbadger.com/images/linuxserver/duckdns "Get your own version badge on microbadger.com")
2019-09-07 19:32:58 +00:00
[![Docker Pulls ](https://img.shields.io/docker/pulls/linuxserver/duckdns.svg?style=flat-square&color=E68523 )](https://hub.docker.com/r/linuxserver/duckdns)
[![Docker Stars ](https://img.shields.io/docker/stars/linuxserver/duckdns.svg?style=flat-square&color=E68523 )](https://hub.docker.com/r/linuxserver/duckdns)
2019-08-31 19:32:58 +00:00
[![Build Status ](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-duckdns/job/master/badge/icon?style=flat-square )](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-duckdns/job/master/)
2019-03-30 20:32:40 +00:00
[![ ](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/duckdns/latest/badge.svg )](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/duckdns/latest/index.html)
2019-02-09 20:33:32 +00:00
2019-03-30 20:32:40 +00:00
[Duckdns ](https://duckdns.org/ ) 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.
2019-02-09 20:33:32 +00:00
## Supported Architectures
2019-08-31 19:32:58 +00:00
Our images support multiple architectures such as `x86-64` , `arm64` and `armhf` . We utilise the docker manifest for multi-platform awareness. More information is available from docker [here ](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list ) and our announcement [here ](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/ ).
2019-02-09 20:33:32 +00:00
Simply pulling `linuxserver/duckdns` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
| Architecture | Tag |
2019-03-30 20:32:40 +00:00
| :----: | --- |
2019-02-09 20:33:32 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 19:28:13 +00:00
| armhf | arm32v7-latest |
2019-02-09 20:33:32 +00:00
2019-03-30 20:32:40 +00:00
2019-02-09 20:33:32 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2019-03-30 20:32:40 +00:00
```
2019-02-09 20:33:32 +00:00
docker create \
--name=duckdns \
2019-03-02 20:32:44 +00:00
-e PUID=1000 `#optional` \
-e PGID=1000 `#optional` \
2019-02-09 20:33:32 +00:00
-e TZ=Europe/London \
-e SUBDOMAINS=subdomain1,subdomain2 \
-e TOKEN=token \
2019-02-13 16:48:38 +00:00
-e LOG_FILE=false `#optional` \
-v < /path/to/appdata/config>:/config `#optional` \
2019-02-09 20:33:32 +00:00
--restart unless-stopped \
linuxserver/duckdns
```
2019-03-30 20:32:40 +00:00
2019-02-09 20:33:32 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
duckdns:
image: linuxserver/duckdns
container_name: duckdns
environment:
2019-03-02 20:32:44 +00:00
- PUID=1000 #optional
- PGID=1000 #optional
2019-02-09 20:33:32 +00:00
- TZ=Europe/London
- SUBDOMAINS=subdomain1,subdomain2
- TOKEN=token
2019-02-13 16:48:38 +00:00
- LOG_FILE=false #optional
volumes:
volumes:
- < /path/to/appdata/config>:/config #optional
2019-02-09 20:33:32 +00:00
restart: unless-stopped
```
## Parameters
2019-03-30 20:32:40 +00:00
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
2019-02-09 20:33:32 +00:00
2019-03-30 20:32:40 +00:00
### Ports (`-p`)
2019-02-09 20:33:32 +00:00
| Parameter | Function |
2019-03-30 20:32:40 +00:00
| :----: | --- |
2019-02-09 20:33:32 +00:00
2019-03-30 20:32:40 +00:00
### Environment Variables (`-e`)
2019-02-09 20:33:32 +00:00
| Env | Function |
2019-03-30 20:32:40 +00:00
| :----: | --- |
2019-03-02 20:32:44 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-09 20:33:32 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
| `SUBDOMAINS=subdomain1,subdomain2` | multiple subdomains allowed, comma separated, no spaces |
| `TOKEN=token` | DuckDNS token |
2019-03-30 20:32:40 +00:00
| `LOG_FILE=false` | Set to `true` to log to file (also need to map /config). |
2019-02-09 20:33:32 +00:00
2019-03-30 20:32:40 +00:00
### Volume Mappings (`-v`)
2019-02-09 20:33:32 +00:00
| Volume | Function |
2019-03-30 20:32:40 +00:00
| :----: | --- |
2019-02-13 16:48:38 +00:00
| `/config` | Used in conjunction with logging to file. |
2019-02-09 20:33:32 +00:00
2019-03-30 20:32:40 +00:00
2019-02-13 16:48:38 +00:00
## User / Group Identifiers
2019-03-30 20:32:40 +00:00
When using 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` .
2019-02-13 16:48:38 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-02 20:32:44 +00:00
In this instance `PUID=1000` and `PGID=1000` , to find yours use `id user` as below:
2019-02-13 16:48:38 +00:00
2019-03-30 20:32:40 +00:00
```
2019-02-13 16:48:38 +00:00
$ id username
2019-03-02 20:32:44 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-13 16:48:38 +00:00
```
2019-02-09 20:33:32 +00:00
## Application Setup
2019-03-30 20:32:40 +00:00
- Go to the [duckdns website ](https://duckdns.org/ ), register your subdomain(s) and retrieve your token
- Create a container with your subdomain(s) and token
- It will update your IP with the DuckDNS service every 5 minutes
2019-02-09 20:33:32 +00:00
## Support Info
2019-08-31 19:32:58 +00:00
* Shell access whilst the container is running:
2019-02-09 20:33:32 +00:00
* `docker exec -it duckdns /bin/bash`
2019-08-31 19:32:58 +00:00
* To monitor the logs of the container in realtime:
2019-02-09 20:33:32 +00:00
* `docker logs -f duckdns`
2019-08-31 19:32:58 +00:00
* Container version number
2019-02-09 20:33:32 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' duckdns`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/duckdns`
## Versions
2019-09-24 18:16:47 +00:00
* **24.09.19:** - Fix perms on github and remove chmod that can stall the container.
2019-06-30 19:38:29 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-03-24 19:28:13 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-24 03:24:43 +00:00
* **22.02.19:** - Rebasing to alpine 3.9.
2019-02-13 16:48:38 +00:00
* **08.02.19:** - Update readme with optional parameters.
2019-02-09 20:33:32 +00:00
* **10.12.18:** - Fix docker compose example.
* **15.10.18:** - Multi-arch image.
* **22.08.18:** - Rebase to alpine 3.8.
* **08.12.17:** - Rebase to alpine 3.7.
* **28.05.17:** - Rebase to alpine 3.6.
* **09.02.17:** - Rebase to alpine 3.5.
* **17.11.16:** - Initial release.