Skip to content

Commit

Permalink
Add installation instructions for Docker image
Browse files Browse the repository at this point in the history
  • Loading branch information
Programie committed Sep 1, 2019
1 parent 5b21226 commit ae07d1a
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ PHP DynDNS also supports IPv6! To update both, the IPv4 and IPv6 address, just m
* A web server running PHP 7.2 or newer
* A DNS server (e.g. bind)

Or use the ready to run Docker image (see section "Installation using Docker")

## Installation

There are two methods for getting the latest release:
Expand All @@ -36,6 +38,18 @@ Once downloaded, continue with the following steps:
* Configure your DNS server to allow update requests from the webserver (e.g. `allow-update { localhost; }` in bind)
* [Configure your router](https://gitlab.com/Programie/PHPDynDNS/wikis/Configure-your-router) to automatically request the URL of your DynDNS service after each reconnect (or create a cronjob with curl/wget).

## Installation using Docker

PHPDynDNS is also provided as a Docker image. Just pull it from [Docker Hub](https://hub.docker.com/r/programie/phpdyndns).

Mount your config.json to */app/config.json*

Example command to start the container:

```
docker run -d --name phpdyndns -p 80:80 -v /path/to/config.json:/app/config.json:ro programie/phpdyndns
```

## Important

Make sure the config.json is not readable via HTTP! On Apache this is already done using the *.htaccess* file.

0 comments on commit ae07d1a

Please sign in to comment.