# Namecheap DDNS

[![Latest Version](https://img.shields.io/crates/v/namecheap-ddns.svg)](https://crates.io/crates/namecheap-ddns)
[![Downloads](https://img.shields.io/github/downloads/nickjer/namecheap-ddns/total.svg)](https://github.com/nickjer/namecheap-ddns/releases)
[![License](https://img.shields.io/github/license/nickjer/namecheap-ddns.svg)](https://github.com/nickjer/namecheap-ddns)
[![Continuous Integration Status](https://github.com/nickjer/namecheap-ddns/workflows/Continuous%20integration/badge.svg)](https://github.com/nickjer/namecheap-ddns/actions)

A command line interface (CLI) used to update the A + Dynamic DNS records for
Namecheap.

## Pre-compiled Binaries

You can download and run the [pre-compiled binaries] to get up and running
immediately.

## Installation

An alternative is to install using [cargo]:

```shell
cargo install namecheap-ddns
```

## Usage

Check the help (`--help`) for details on using this tool:

```shell
Updates the A + Dynamic DNS records for Namecheap

Usage: namecheap-ddns [OPTIONS] --domain <DOMAIN> --subdomain <SUBDOMAIN> --token <TOKEN>

Options:
  -d, --domain <DOMAIN>        The domain with subdomains [env: NAMECHEAP_DDNS_DOMAIN=]
  -s, --subdomain <SUBDOMAIN>  The subdomain to update [env: NAMECHEAP_DDNS_SUBDOMAIN=]
  -i, --ip <IP>                The ip address to set on the subdomains (if
                               blank the ip used to make this request will be
                               used) [env: NAMECHEAP_DDNS_IP=]
  -t, --token <TOKEN>          The secret token [env: NAMECHEAP_DDNS_TOKEN=]
  -h, --help                   Print help
  -V, --version                Print version
```

You will need to specify Namecheap's Dynamic DNS Password provided to you in
their Advanced DNS control panel as the environment variable
`NAMECHEAP_DDNS_TOKEN`.

> *Tip:* This is not your Namecheap login password.

### Examples

I want to update the host `host1.example.com` with my current public facing ip
address:

```console
$ NAMECHEAP_DDNS_TOKEN=... namecheap-ddns -d example.com -s host1
host1.example.com IP address updated to: 123.123.123.123
```

I want to update multiple subdomains (`host1`, `host2`, and `host3`) with a
given ip address:

```console
$ NAMECHEAP_DDNS_TOKEN=... namecheap-ddns \
>     -d example.com \
>     -s host1 -s host2 -s host3
>     -i 123.123.123.123
host1.example.com IP address updated to: 123.123.123.123
host2.example.com IP address updated to: 123.123.123.123
host3.example.com IP address updated to: 123.123.123.123
```

I want to use an environment variable file:

```console
$ cat .env
export NAMECHEAP_DDNS_TOKEN=...
export NAMECHEAP_DDNS_DOMAIN=example.com
export NAMECHEAP_DDNS_SUBDOMAIN=host1,host2
export NAMECHEAP_DDNS_IP=321.321.321.321
$ source .env
$ namecheap-ddns
host1.example.com IP address updated to: 321.321.321.321
```

## Linux - systemd

If you want to set this up as a service you will need to create a service file
and corresponding timer.

1. Create the service itself that updates your subdomains:

   ```desktop
   # /etc/systemd/system/ddns-update.service

   [Unit]
   Description=Update DDNS records for Namecheap
   After=network-online.target

   [Service]
   Type=simple
   Environment=NAMECHEAP_DDNS_TOKEN=<TOKEN>
   Environment=NAMECHEAP_DDNS_DOMAIN=<DOMAIN>
   Environment=NAMECHEAP_DDNS_SUBDOMAIN=<SUBDOMAIN>
   ExecStart=/path/to/namecheap-ddns
   User=<USER>

   [Install]
   WantedBy=default.target
   ```

   Be sure to fill in the correct path to your binary as well as the
   environment variables.

2. Note that the super secret token is in this file, so we should set
   restrictive permissions:

   ```shell
   sudo chmod 600 /etc/systemd/system/ddns-update.service
   ```

3. Create the timer that runs this service:

   ```desktop
   # /etc/systemd/system/ddns-update.timer

   [Unit]
   Description=Run DDNS update every 15 minutes
   Requires=ddns-update.service

   [Timer]
   Unit=ddns-update.service
   OnUnitInactiveSec=15m
   AccuracySec=1s

   [Install]
   WantedBy=timers.target
   ```

4. Now we reload the daemon with the new services and start them:

   ```shell
   sudo systemctl daemon-reload
   sudo systemctl start ddns-update.service ddns-update.timer
   ```

You can view the logs from the service with the following command:

```shell
sudo journalctl -u ddns-update.service
```

[cargo]: https://doc.rust-lang.org/cargo/
[pre-compiled binaries]: https://github.com/nickjer/namecheap-ddns/releases