danielcharrua/cloudflare-backup

Backup your CloudFlare hosted DNS records

Simple console tool for backing up your CloudFlare hosted DNS records.

🇪🇸 Spanish guide here.

Installation

npm install -g danielcharrua/cloudflare-backup

Usage

Local machine

Set CF_EMAIL and CF_TOKEN environment variables to your CloudFlare account email address and API key, respectively, and run cf-backup. All of the DNS records for all of your zones will be dumped to stdout in a BIND compatible format. It also saves zone's comments ✌️

CF_EMAIL=<cf-account-email-address> CF_TOKEN=<cf-account-global-api-key> cf-backup > zones.bind.txt

Docker

The package can be run inside a container that runs a cronjob every 24h. You can download and use the image https://hub.docker.com/r/danielpcostas/cloudflare-backup The output txt file will be placed on /app directory.

docker run \
    --name cloudflare-backup \
    --env 'CF_EMAIL=<cf-account-email-address>' \
    --env 'CF_TOKEN=<cf-account-global-api-key>' \
    --restart=always \
    danielpcostas/cloudflare-backup

Data persistency

For data persistency of the output file create a volume and mount it in /storage. In this case the output txt file will be placed on /home/username/cloudflare-backup. Change this route to match some folder on your filesystem.

docker run \
    --name cloudflare-backup \
    --volume /home/username/cloudflare-backup:/storage \
    --env 'CF_EMAIL=<cf-account-email-address>' \
    --env 'CF_TOKEN=<cf-account-global-api-key>' \
    --restart=always \
    danielpcostas/cloudflare-backup

Auto delete backups

By default the backup zones files will be persisted for 6 months (180 days). This will give you plenty of time to have and manage old records. You can customize this value to fit your needs.

docker run \
    --name cloudflare-backup \
    --volume /home/username/cloudflare-backup:/storage \
    --env 'CF_EMAIL=<cf-account-email-address>' \
    --env 'CF_TOKEN=<cf-account-global-api-key>' \
    --env 'BACKUP_DAYS=365' \
    --restart=always \
    danielpcostas/cloudflare-backup

NAS (with Docker)

You can use this package with with your NAS after installing docker and adding the docker image. When running the container you can add the .env variables, mount the volume and the restart policy.

Credits

Special thanks to 🦊🥕 Satoshiba 🔑⚡️ for the help with Docker.
This package is a fork of rmg/cloudflare-backup. Originally created by Ryan Graham.

Send some love

To keep working and maintainig this free package please consider buying me a coffee. Thank you ✌️