lindyndns

Linode Dynamic DNS Client

Linode Setup

Create a linode account for the user. For added security, create the domain they will be using and give them only access to that domain.

Have the user create an API key with domain read/write and IP read scopes, or give them access to an API key that has read/write permissions for domains.

To allow lindyndns to update, but not create a domain, create the domain and give the user access to update only the one domain they need access to.

Configuration

Create a config.toml, (with each <VARIABLE> replaced):

api_token = "<API_KEY>"
domain = "<DOMAIN>"
soa_email = "<EMAIL>"

Configuration file locations:

User:

• Linux
  • $XDG_CONFIG_HOME/lindyndns/config.toml
• MacOS
  • ~/Library/Preferences/lindyndns/config.toml
• Windows
  • %APPDATA%\lindyndns\config.toml

System wide:

• Linux
  • /etc/xdg/lindyndns/config.toml
• MacOS
  • /Library/Preferences/lindyndns/config.toml
• Windows
  • %APPDATA%\lindyndns\config.toml

Usage

Running lindyndns will create the specified domain if the user has permissions to create a domain, otherwise an error message will be printed.

If all permissions are correct, running lindyndns will update the specified domain, and print the IP address of the user.

Scheduling

After creating configuration, start the service. The config should be system wide if running the system service.

Linux

systemctl enable --now lindyndns.timer

MacOS

launchctl bootstrap system /Library/LaunchDaemons/ca.johnramsden.lindyndns.plist

Modify the update interval by editing /Library/LaunchDaemons/ca.johnramsden.lindyndns.plist.

Check it's running with launchctl list | grep lindyndns

Windows

If installed from the .exe installer, a schedule of job should have been created in the windows scheduler which will run every half hour.

Installing

Several pre-built packages are available depending on the platform under the releases page.

• Linux:
  • tarball
  • .deb package
• MacOS
  • tarball
  • .pkg
• Windows
  • zip archive
  • .exe installer

Building

Clone the repo.

With rust and cargo installed run:

cargo build --release

FreeBSD example:

pkg install rust git
git clone https://github.com/johnramsden/lindyndns.git
cd lindyndns
cargo build --release

The binary will be at target/release/lindyndns. Move it to /usr/local/bin/lindyndns, add a configfile to /etc/xdg/lindyndns/config.toml and create a crontab entry to run lindyndns regularly.

License

This project is licensed under the MIT License.