From 65355ee85070181c45b8a76ee65a152790407e87 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Sat, 2 May 2020 15:35:02 -0400 Subject: [PATCH] Bot Updating Documentation --- images/docker-duckdns.md | 56 +++++++++++++++++++++++++--------------- 1 file changed, 35 insertions(+), 21 deletions(-) diff --git a/images/docker-duckdns.md b/images/docker-duckdns.md index 4ec25b35f..653206d36 100644 --- a/images/docker-duckdns.md +++ b/images/docker-duckdns.md @@ -1,8 +1,17 @@ -# linuxserver/duckdns +# [linuxserver/duckdns](https://github.com/linuxserver/docker-duckdns) -[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-duckdns.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-duckdns) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-duckdns.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-duckdns/releases) [![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-duckdns/packages) [![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-duckdns/container_registry) [![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/duckdns) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/duckdns.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/duckdns) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/duckdns.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/duckdns) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/duckdns.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/duckdns) [![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/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/duckdns/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/duckdns/latest/index.html) +[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-duckdns.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-duckdns) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-duckdns.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-duckdns/releases) +[![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-duckdns/packages) +[![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-duckdns/container_registry) +[![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/duckdns) +[![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") +[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/duckdns.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/duckdns) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/duckdns.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/duckdns) +[![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/) +[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/duckdns/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/duckdns/latest/index.html) -[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. +[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. ## Supported Architectures @@ -13,18 +22,19 @@ Simply pulling `linuxserver/duckdns` should retrieve the correct image for your The architectures supported by this image are: | Architecture | Tag | -| :---: | :--- | +| :----: | --- | | x86-64 | amd64-latest | | arm64 | arm64v8-latest | | armhf | arm32v7-latest | + ## Usage Here are some example snippets to help you get started creating a container from this image. ### docker -```text +``` docker create \ --name=duckdns \ -e PUID=1000 `#optional` \ @@ -38,6 +48,7 @@ docker create \ linuxserver/duckdns ``` + ### docker-compose Compatible with docker-compose v2 schemas. @@ -64,55 +75,59 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `:` 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. +Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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. -### Ports \(`-p`\) +### Ports (`-p`) | Parameter | Function | -| :---: | :--- | +| :----: | --- | -### Environment Variables \(`-e`\) +### Environment Variables (`-e`) | Env | Function | -| :---: | :--- | +| :----: | --- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | | `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 | -| `LOG_FILE=false` | Set to `true` to log to file \(also need to map /config\). | +| `LOG_FILE=false` | Set to `true` to log to file (also need to map /config). | -### Volume Mappings \(`-v`\) +### Volume Mappings (`-v`) | Volume | Function | -| :---: | :--- | +| :----: | --- | | `/config` | Used in conjunction with logging to file. | + + + ## User / Group Identifiers -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`. +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`. Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic. In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: -```text +``` $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` ## Application Setup -* 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 +- 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 + ## Docker Mods +[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27duckdns%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=duckdns "view available mods for this container.") -[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27duckdns%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=duckdns) +We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above. -We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image \(if any\) can be accessed via the dynamic badge above. ## Support Info @@ -141,4 +156,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to * **28.05.17:** - Rebase to alpine 3.6. * **09.02.17:** - Rebase to alpine 3.5. * **17.11.16:** - Initial release. -