unifios-utilities/cloudflare-ddns/README.md
StealthCT 4a1d6f11b3
Path references for boostchicken-dev and forks (#341)
* Fix Github references from boostchicken to boostchicken-dev

* Download CNI bridge script from upstream rather than fork

The remote_install.sh script was retrieving the 05-cni-bridge.sh script
from gtrabanco's fork, rather than the main repository.

* Rename 05-cni-bridge.sh to 06-cni-bridge.sh
2022-03-25 06:08:14 -07:00

47 lines
1.6 KiB
Markdown

# Cloudflare Dynamic DNS
## Features
- Update Multiple Subdomains
- Proxy your traffic through cloudflare
- Set a ttl
Complete feature list and documentation can be found [here](https://github.com/timothymiller/cloudflare-ddns)
## Requirements
1. You have successfully setup the on boot script described [here](https://github.com/boostchicken-dev/udm-utilities/tree/master/on-boot-script)
2. You must have a cloudflare profile with at least one domain.
3. You must have a valid cloudflare api token with correct permissions (see [complete documentation](https://github.com/timothymiller/cloudflare-ddns) for details)
## Customization
Update [config.json](configs/config.json) with the following options:
- your cloudflare api token
- your zone id
- each subdomain you'd like to point at your udm-pro
- Set the proxied flag if you'd like cloudflare to proxy the records
- Set the ttl value you'd like for your records
## Steps
2. Make a directory for your configuration
```sh
mkdir -p /mnt/data/cloudflare-ddns
```
3. Create a [cloudflare-ddns configuration](configs/config.json) in `/mnt/data/cloudflare-ddns` and update the configuration to meet your needs.
4. Copy [30-cloudflare-ddns.sh](on_boot.d/30-cloudflare-ddns.sh) to `/mnt/data/on_boot.d`.
5. Execute /mnt/data/on_boot.d/[30-cloudflare-ddns.sh](on_boot.d/30-cloudflare-ddns.sh)
7. Execute `podman logs cloudflare-ddns` to verify the continer is running without error (ipv6 warnings are normal).
### Useful commands
```sh
# view cloudflare-ddns logs to verify the continer is running without error (ipv6 warnings are normal).
podman logs cloudflare-ddns
```