mxplusb / cloudflare-sync Archived

cloudflare-sync

A nice to have, MIT-licensed tool for using Cloudflare as a dynamic DNS provider.

Usage

Before you get started, ensure that you have a Cloudflare site (one or more, doesn't matter since it's by Zone ID) so records can be updated. Leveraging the config/example.json, create a file that you want to contain your own DNS A records. Run go build -v ./cmd -o cloudflare-sync.exe, then leverage cloudflare-sync.exe -h for the specifics.

Currently this is undergoing an overhaul, so please feel to provide some feedback on its changes.

Configuration

The configuration is file-based, you can find an example of the schema in config/example.json. You need to pass this file via a flag, which you can find with cloudflare-sync.exe --help. This file is a subset of the Cloudflare API, so if you don't want it to override the values you already have in Cloudflare, just make sure they match. Please feel free to update this configuration section with more commentary if my explanation isn't satisfactory.

Docker

There is a Dockerfile you can use to push to your own registry, if you want. You can also leverage my pre-built one at cr.r3t.io/library/cloudflare-sync:latest if you want. Here is a template command you'll want:

docker run \
    -ti \
    -e "API_TOKEN=''" \
    -e "ZONE_ID=''" \
    -e "FREQUENCY=30" \
    -e "RECORDS_FILE_NAME=production.json" \
    cr.r3t.io/library/cloudflare-sync

Don't forget to pass in your own production.json file via docker volumes.

Kubernetes

There is a kubernetes.yml file which you can use to deploy a ConfigMap and Deployment for this. You shouldn't ever need more than one replica. Fill out the ConfigMap, spec.template.spec.containers[0].env values, and data.production.json with your configuration.

Contributors

This project exists thanks to all the people who contribute. [Contribute].