https://github.com/lfaoro/flares

Flares 🔥 is a CloudFlare DNS backup tool
https://github.com/lfaoro/flares

backup cloudflare dns export

Last synced: 6 days ago
JSON representation

Flares 🔥 is a CloudFlare DNS backup tool

• Host: GitHub
• URL: https://github.com/lfaoro/flares
• Owner: lfaoro
• License: bsd-3-clause
• Created: 2018-10-16T15:35:00.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-10-26T09:35:51.000Z (about 1 year ago)
• Last Synced: 2024-08-01T16:33:35.416Z (3 months ago)
• Topics: backup, cloudflare, dns, export
• Language: Go
• Homepage:
• Size: 2.52 MB
• Stars: 186
• Watchers: 8
• Forks: 15
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-cloudflare - Flares - DNS backup tool. (DNS)
• awesome-cloudflare - Flares - DNS backup tool. (DNS)

README

        
# Flares 🔥

Flares is a CloudFlare DNS backup tool, it dumps your DNS table to the screen or exports it as BIND formatted zone

files.

[![BSD License](https://img.shields.io/badge/license-BSD-blue.svg?style=flat)](LICENSE)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Flfaoro%2Fflares.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Flfaoro%2Fflares?ref=badge_shield)

[![Go Report Card](https://goreportcard.com/badge/github.com/lfaoro/flares)](https://goreportcard.com/report/github.com/lfaoro/flares)

![Docker Pulls](https://img.shields.io/docker/pulls/lfaoro/flares.svg?logo=docker&style=popout-square)

[![PayPal](https://img.shields.io/badge/paypal-contribute-blue.svg?style=popout-square&logo=paypal)](https://www.paypal.com/pools/c/8fm4OKBYMa)

## Quick Start

### [Video Tutorial](https://asciinema.org/a/NLVa6TyQzvTEhnzZDdH1q79lO)

### Docker

```bash

# Fetch your CloudFlare API token from here:

# https://dash.cloudflare.com/profile/api-tokens

# -> Create Token

# -> Edit zone DNS

# -> Permission: read

# -> Zone resources: Include -> All zones

$ export CF_API_TOKEN="KClp4y8BgD2LQiz2..."

$ docker run -it --rm \

-e CF_API_TOKEN="$CF_API_TOKEN" \

lfaoro/flares domain1.tld domain2.tld

```

### macOS

```bash

brew install lfaoro/tap/flares

```

### Linux/BSD

```bash

curl https://raw.githubusercontent.com/lfaoro/flares/master/install.sh | bash

```

### Developers

> Go installer: https://golang.org/dl/

```bash

go get -u github.com/lfaoro/flares

make install

flares -h

make test

```

## Examples

```bash

$ make install

$ flares -h

$ flares domain1.tld

;;

;; Domain:     domain1.tld

;; Exported:   2019-06-03 06:31:29

...continued

$ flares --export domain1.tld domain2.tld

BIND table for domain1.tld successfully exported

BIND table for domain2.tld successfully exported

$ ls

domain1.tld domain2.tld

```

## Automation

### GitLab CI/CD

- Copy [.gitlab-ci.yml](.gitlab-ci.yml) inside your repo

- Use the [pipeline schedules](https://gitlab.com/help/user/project/pipelines/schedules) feature

- Each run of the task will generate a DNS backup stored as a downloadable artifact

# Contributing

> Any help and suggestions are very welcome and appreciated. Start by opening an [issue](https://github.com/lfaoro/flares/issues/new).

- Fork the project

- Create your feature branch `git checkout -b my-new-feature`

- Commit your changes `git commit -am 'Add my feature'`

- Push to the branch `git push origin my-new-feature`

- Create a new pull request against the master branch