wwadge / flares

CloudFlare Utilities

Flares 🔥

A collection of utilities that help you interact with the CloudFlare service.

Installation

Golang must be installed: https://golang.org/dl/

# flaredns
$ go get -u github.com/lfaoro/flares/cmd/flaredns
$ cd $GOPATH/src/github.com/lfaoro/flares/
# flarelogs (coming soon)
# $ go get -u github.com/lfaoro/flares/cmd/flarelogs

Quick start (painless)

# CloudFlare auth key is here: https://dash.cloudflare.com/profile ->
# Global API Key -> View
$ docker run -it --rm \
-e CF_AUTH_KEY="" \
-e CF_AUTH_KEY="" \
-e CF_AUTH_EMAIL="" \
-e GIT_REPO="" \
-e GIT_USERNAME="" \
-e GIT_PASSWORD="" \
lfaoro/flares flaredns -domains awesome.tld,awesome2.tld

Quick start (I want full control)

Fill the .env with your CloudFlare and Git credentials

# Provide a .env file in your project with the following variables or export them.
# Check .env.example
$ cat > .env << EOF
CF_AUTH_KEY=""
CF_AUTH_EMAIL=""
GIT_REPO=""
GIT_USERNAME=""
GIT_PASSWORD=""
EOF

Create your docker container

docker build -t flares .

Run the app

docker run -it --rm flares flaredns -domains awesome.tld,awesome2.tld

Contibuting

Any help and suggestions are very welcome and appreciated. Start by opening an issue.

• 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

TODO

• use https://github.com/spf13/cobra for the CLI interface
• add the flarelogs command
• use a git library instead of our own hacky interface