diff --git a/README.md b/README.md index 6fc8867..88c5315 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,30 @@ So far it has modules for these domain provider APIs: - [dyn.com API](https://help.dyn.com/remote-access-api/perform-update/) (untested) # Dependencies +- iproute2 - curl - miniupnpc (optional, see the Configuration section) +- bind (optional, when using the http.net DNS API) # Installation +There's no automated installation yet. As an example we install the two scripts `homeserverdns-daemon` and `homeserverdns-update` to `/usr/bin` and the configuration file to `/etc`. -TBD +```shell +sudo cp homeserverdns-daemon homeserverdns-update /usr/bin +sudo cp homeserverdns.cfg /etc +``` + +If we want to use systemd to control homeserverdns, we need to install the service file `homeserverdns.service`. We have to make sure that the path of the config file is correct in that file. + +```shell +sudo cp homeserverdns.service /etc/systemd/system +``` + +Once the configuration is done we can start homeserverdns using + +```shell +sudo systemctl start homeserverdns +``` # Configuration All configuration options are described in more detail in `homeserverdns.cfg`. This is only an overview on the most important options. diff --git a/homeserverdns.service b/homeserverdns.service new file mode 100644 index 0000000..dfaf0de --- /dev/null +++ b/homeserverdns.service @@ -0,0 +1,9 @@ +[Unit] +After=network.target +Description=DNS updater for home servers + +[Service] +ExecStart=/usr/bin/env bash -c 'homeserverdns-daemon /etc/homeserverdns.cfg' +Group=nobody +User=nobody +Type=simple