Bot Updating Templated Files

pull/9/head
LinuxServer-CI 2019-10-05 20:32:57 +01:00
rodzic 2a87cc29a6
commit eff2eb0e86
1 zmienionych plików z 30 dodań i 19 usunięć

Wyświetl plik

@ -1,8 +1,14 @@
# linuxserver/duckdns # [linuxserver/duckdns](https://github.com/linuxserver/docker-duckdns)
[![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) [![MicroBadger Size](https://img.shields.io/microbadger/image-size/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)](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) [![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 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")
[![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)
[![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 ## Supported Architectures
@ -13,18 +19,19 @@ Simply pulling `linuxserver/duckdns` should retrieve the correct image for your
The architectures supported by this image are: The architectures supported by this image are:
| Architecture | Tag | | Architecture | Tag |
| :---: | :--- | | :----: | --- |
| x86-64 | amd64-latest | | x86-64 | amd64-latest |
| arm64 | arm64v8-latest | | arm64 | arm64v8-latest |
| armhf | arm32v7-latest | | armhf | arm32v7-latest |
## Usage ## Usage
Here are some example snippets to help you get started creating a container from this image. Here are some example snippets to help you get started creating a container from this image.
### docker ### docker
```text ```
docker create \ docker create \
--name=duckdns \ --name=duckdns \
-e PUID=1000 `#optional` \ -e PUID=1000 `#optional` \
@ -38,6 +45,7 @@ docker create \
linuxserver/duckdns linuxserver/duckdns
``` ```
### docker-compose ### docker-compose
Compatible with docker-compose v2 schemas. Compatible with docker-compose v2 schemas.
@ -64,49 +72,53 @@ services:
## Parameters ## Parameters
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. 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.
### Ports \(`-p`\) ### Ports (`-p`)
| Parameter | Function | | Parameter | Function |
| :---: | :--- | | :----: | --- |
### Environment Variables \(`-e`\) ### Environment Variables (`-e`)
| Env | Function | | Env | Function |
| :---: | :--- | | :----: | --- |
| `PUID=1000` | for UserID - see below for explanation | | `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation |
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London | | `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
| `SUBDOMAINS=subdomain1,subdomain2` | multiple subdomains allowed, comma separated, no spaces | | `SUBDOMAINS=subdomain1,subdomain2` | multiple subdomains allowed, comma separated, no spaces |
| `TOKEN=token` | DuckDNS token | | `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 | | Volume | Function |
| :---: | :--- | | :----: | --- |
| `/config` | Used in conjunction with logging to file. | | `/config` | Used in conjunction with logging to file. |
## User / Group Identifiers ## 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. 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: In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
```text ```
$ id username $ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
``` ```
## Application Setup ## Application Setup
* Go to the [duckdns website](https://duckdns.org/), register your subdomain\(s\) and retrieve your token - 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 - Create a container with your subdomain(s) and token
* It will update your IP with the DuckDNS service every 5 minutes - It will update your IP with the DuckDNS service every 5 minutes
## Support Info ## Support Info
@ -133,4 +145,3 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
* **28.05.17:** - Rebase to alpine 3.6. * **28.05.17:** - Rebase to alpine 3.6.
* **09.02.17:** - Rebase to alpine 3.5. * **09.02.17:** - Rebase to alpine 3.5.
* **17.11.16:** - Initial release. * **17.11.16:** - Initial release.