Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
arnested committed Jan 8, 2021
1 parent 02be676 commit 198896b
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
A systemd service that will monitor your Docker host and provide
DNS names for containers with a `VIRTUAL_HOST` environment variable.

The domain names will be broadcast using multicast DNS.
The service broadcasts the domain names using multicast DNS.

A limitation of this is that domains name can only be on the `.local`
TLD and only have one level below the TLD. A benefit is that you don't
Expand All @@ -20,10 +20,13 @@ https://my-fancy.local).

## Install

Download the `.deb` file and run:
For Pop!_OS, Ubuntu, Debian and the like, download the `.deb` package
file from the [latest
release](https://github.com/arnested/ldddns/releases/latest) and open
it or run:

```console
sudo dpkg -i ldddns_0.0.16_linux_amd64.deb
sudo dpkg -i ldddns_0.0.38_linux_amd64.deb
```

Or just run the following command which will download and install the
Expand All @@ -32,3 +35,14 @@ latest package for you:
```console
curl -fsSL https://ldddns.arnested.dk/install.sh | bash
```

For other distributions download the binary from the [latest
release](https://github.com/arnested/ldddns/releases/latest) and
create a systemd service unit file yourself based on
[`ldddns.service`](https://github.com/arnested/ldddns/blob/main/ldddns.service).

### Updates

When you install the package it will add an APT source list so you
will receive future updates to `ldddns` along with your other system
updates.

0 comments on commit 198896b

Please sign in to comment.