Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yzen90/dynaflare
Simple DDNS client for Cloudflare.
https://github.com/yzen90/dynaflare
cloudflare ddns rust
Last synced: about 2 months ago
JSON representation
Simple DDNS client for Cloudflare.
- Host: GitHub
- URL: https://github.com/yzen90/dynaflare
- Owner: Yzen90
- License: gpl-3.0
- Created: 2024-11-13T05:24:11.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-17T04:35:28.000Z (about 2 months ago)
- Last Synced: 2024-11-17T05:37:18.251Z (about 2 months ago)
- Topics: cloudflare, ddns, rust
- Language: Rust
- Homepage:
- Size: 43 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DynaFlare
#### Simple IPv4 DDNS client for Cloudflare. Works on the Raspberry Pi!
### 1. Obtaining DynaFlare
#### Build from source
```shell
git clone https://github.com/Yzen90/dynaflare.git
cd dynaflare
cargo build --release
```
#### Install crate
```shell
cargo install dynaflare
```
#### Download a pre-built binary
- [Linux aarch64](https://github.com/Yzen90/dynaflare/releases/latest/download/dynaflare-aarch64-linux.zip)
- [Linux x86_64](https://github.com/Yzen90/dynaflare/releases/latest/download/dynaflare-x86_64-linux.zip)
- [Windows x86_64](https://github.com/Yzen90/dynaflare/releases/latest/download/dynaflare-x86_64-windows.zip)
### 2. Configuration
DynaFlare looks in the current working directory for a `configuration.toml` file with the following fields:
- `interval` (Optional): String with one or more pairs of a positive integer immediately followed by 'days', 'h', 'min', 's', 'ms', 'μs' or 'ns'. If not provided, dynaflare will check and update de provided records only once and then exit. Otherwise dynaflare will keep runing and continuously check at this interval for public ip changes and update the dns records when necessary.
- `zone_id` (Required): ID of the Clouldflare Zone that contains the provided dns records.
- `api_token` (Required): Cloudflare API token with DNS read and edit permissions for the provided zone.
- `records` (Required): DNS records to set to the current public IP address.
#### Example `configuration.toml`
```toml
interval = "1min 30s"
zone_id = "cloudflare zone id here"
api_token = "cloudflare api token here"
records = ["dynamic.example.com"]
```
### 3. systemd service
A systemd service unit file template for DynaFlare is provided in the repository that can be used as follows to install a systemd service:
```shell
export DYNAFLARE_USER=dynaflare # User that the process will be executed as
export DYNAFLARE_WDIR=/usr/local/etc/dynaflare # Directory where configuration.toml is located
export DYNAFLARE_EXEC=/usr/local/bin/dynaflare # Path of dynaflare executable file
envsubst < dynaflare.service | sudo tee /etc/systemd/system/dynaflare.service
sudo systemctl start dynaflare
sudo systemctl status dynaflare
sudo systemctl enable dynaflare
```
#### Example systemd unit file
```ini
[Unit]
Description=DynaFlare, a simple DDNS client for Cloudflare
After=network-online.target
Wants=network-online.target
[Service]
Type=simple
User=dynaflare
WorkingDirectory=/usr/local/etc/dynaflare
ExecStart=/usr/local/bin/dynaflare
[Install]
WantedBy=multi-user.target
```