LAB-linuxserver/docker-ddclient
1
0
Fork 0
mirror of https://github.com/linuxserver/docker-ddclient.git synced 2026-02-20 03:15:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

update of README with badges for new ci

Browse Source
This commit is contained in:
sparklyballs 2017-07-12 11:26:13 +01:00
parent 3c6a894c1c
commit 5c620738d4
2 changed files with 2 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -17,7 +17,7 @@ The [LinuxServer.io][linuxserverurl] team brings you another container release f
[DDClient][appurl] is a Perl client used to update dynamic DNS entries for accounts on Dynamic DNS Network Service Provider. It was originally written by Paul Burry and is now mostly by wimpunk. It has the capability to update more than just dyndns and it can fetch your WAN-ipaddress in a few different ways.
[![ddclient](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/ddclient.png)][appurl]
[![ddclient]()][appurl]
## Usage
@ -76,10 +76,7 @@ Edit the ddclient.conf file found in your /config volume. This config file have
## Versions
+ **28.05.2017:** Rebase to alpine 3.6.
+ **10.02.2017:** Rebase to alpine 3.5.
+ **26.11.2016:** Update README to new standard and add icon and other small details.
+ **29.08.2016:** Initial release.
## Credits
Icon made by [Freepik](http://www.flaticon.com/authors/freepik) from [www.flaticon.com](http://www.flaticon.com) is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/)

83
READMETEMPLATE.md
View File

@ -1,83 +0,0 @@
[linuxserverurl]: https://linuxserver.io
[forumurl]: https://forum.linuxserver.io
[ircurl]: https://www.linuxserver.io/irc/
[podcasturl]: https://www.linuxserver.io/podcast/
[appurl]: https://sourceforge.net/p/ddclient/wiki/Home/
[hub]: https://hub.docker.com/r/linuxserver/ddclient/
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
* [forum.linuxserver.io][forumurl]
* [IRC][ircurl] on freenode at `#linuxserver.io`
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
# linuxserver/ddclient
[DDClient](https://sourceforge.net/p/ddclient/wiki/Home/) is a Perl client used to update dynamic DNS entries for accounts on Dynamic DNS Network Service Provider. It was originally written by Paul Burry and is now mostly by wimpunk. It has the capability to update more than just dyndns and it can fetch your WAN-ipaddress in a few different ways.
## Usage
```
docker create \
--name=ddclient \
-v <path to data>:/config \
-e PGID=<gid> -e PUID=<uid> \
-p 1234:1234 \
linuxserver/ddclient
```
## Parameters
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
* `-p 1234` - the port(s)
* `-v /config` - explain what lives here
* `-e PGID` for GroupID - see below for explanation
* `-e PUID` for UserID - see below for explanation
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it ddclient /bin/bash`.
### User / Group Identifiers
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" ™.
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
```
$ id <dockeruser>
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
```
## Setting up the application
Insert a basic user guide here to get a n00b up and running with the software inside the container. DELETE ME
## Info
* Shell access whilst the container is running: `docker exec -it ddclient /bin/bash`
* To monitor the logs of the container in realtime: `docker logs -f ddclient`
* container version number
`docker inspect -f '{{ index .Config.Labels "build_version" }}' ddclient`
* image version number
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/ddclient`
## Versions
+ **10.02.2017:** Rebase to alpine 3.5.
+ **26.11.2016:** Update README to new standard and add icon and other small details.
+ **29.08.2016:** Initial release.
## Credits
Icon made by [Freepik](http://www.flaticon.com/authors/freepik) from [www.flaticon.com](http://www.flaticon.com) is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/)