diff options
author | pommicket <pommicket@gmail.com> | 2025-09-30 21:29:17 -0400 |
---|---|---|
committer | pommicket <pommicket@gmail.com> | 2025-09-30 21:29:17 -0400 |
commit | ace19b98f7e3250d4520a4b893d4aeabe58118c7 (patch) | |
tree | b80febb120ec51d9ede0a12b47cb80d045a1ad92 /README.md | |
parent | f648c5c8136bd86ecbe4bb68120b89afa1390553 (diff) |
Prepare for releasev0.1.0
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..dd41b02 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# simpleddns + +Very simple DDNS client with support for + +- Linode, DigitalOcean, and AWS Route 53 providers. +- Allows obtaining IP address via any shell command. +- Customize TTL, API call interval & timeout. +- Multiple domains. + +Run `install.sh` to install. +Then run `simpleddns --setup` to create a configuration interactively. +Lastly run `simpleddns` to start the DDNS client. +Currently only Unixy platforms are supported (i.e. not Windows, but maybe WSL or MinGW or something). + + +## Alternatives + +This particular set of features is somewhat unique. +But there are other DDNS clients out there: + +- [godns](https://github.com/TimothyYe/godns) +- [ddclient](https://github.com/ddclient/ddclient) + + +## Example systemd service + +(This assumes a user `simpleddns` has installed the program.) + +``` +[Unit] +Description=Simple DDNS client +After=network.target + +[Service] +Restart=always +RestartSec=20 +User=simpleddns +WorkingDirectory=~ +ExecStart=/bin/sh -c .local/bin/simpleddns + +[Install] +WantedBy=multi-user.target +``` |