Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/unnikked/cloudflare-dns-manager

Deprecated - A simple script written in bash to manage DNS Zones using Cloudflare API
https://github.com/unnikked/cloudflare-dns-manager

Last synced: 3 months ago
JSON representation

Deprecated - A simple script written in bash to manage DNS Zones using Cloudflare API

Host: GitHub
URL: https://github.com/unnikked/cloudflare-dns-manager
Owner: unnikked
Created: 2014-04-27T16:57:43.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2016-05-11T08:15:34.000Z (over 8 years ago)
Last Synced: 2023-05-22T00:55:12.821Z (over 1 year ago)
Language: Shell
Homepage:
Size: 7.81 KB
Stars: 5
Watchers: 2
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # DISCLAIMER

This project is deprecated as Cloudflare released a python client recently and updated it's api to v4, check out [here](https://blog.cloudflare.com/python-cloudflare/).

cloudflare-dns-manager

======================

A simple script written in bash to manage DNS Zones using Cloudflare API in order to use it as DDNS service for your machine. 

This script relies on the utility written by _stedolan_.

Go [here](https://github.com/stedolan/jq) and install first his utility, otherwise the script will not work.

# How to use

First of all you need to have a domain configured with CloudFlare. 

Go to the [Account Section](https://www.cloudflare.com/my-account) and grab your __API KEY__.

With this script you can __CREATE__, __MODIFY__ or __DELETE__ any type or DNS record (i.e _A_, _CNAME_, _MX_ etc.) either using your public machine IP or using a specified IP.

## Syntax

- _email_ : your cloudflare account email

- _token_ : your cloudflare apy key

- _action_ : __CREATE__, __MODIFY__ or __DELETE__

- _domain_ : your domain name

- _type_ : _A_, _CNAME_, _MX_ etc.

- _zonename_ : the value of your record (example.domain.com)

- _servicemode_ : if you want to enable CDN feature of cloudflare (0 - disable, 1 - enabled)

- _ip_ : (optional) if you specify an ip in the format `xxx.xxx.xxx.xxx` the script will use it, otherwise will be used your public ip. 

### Examples

- `./dyndns.sh [email protected] tokenid CREATE domain.com A example.domain.com 0`

- `./dyndns.sh [email protected] tokenid MODIFY domain.com A example.domain.com 0`

- `./dyndns.sh [email protected] tokenid DELETE domain.com A example.domain.com 0`

Setting a cron with this script will automatically refresh your machine IP if your dinamic IP changes. 

`*/5 * * * * /path/to/the/script/dyndns.sh [email protected] tokenid MODIFY domain.com A example.domain.com 0`

Every 5 minutes this commands will fire causing an update of your A record if your local machine IP changes. 

Please note that you will have to configure also your router to portforward your public ip to your subnet address.

## Short hands

I've created some bash function in order to get more "user friendly" the functions of the script. 

Put those functions into your `.bash_profile` or `.bashrc`.

You must install globally my script: 

`cp path/to/dynds.sh /urs/bin/`

or just put my repo on your environment global PATH.

```bash

CLOUDFLARE_EMAIL="[email protected]"

CLOUDFLARE_KEY="youapikey"

function dns-create() {

    if [ $# -lt 4 ]; then

        echo "USAGE $0 [domain] [type] [zone_name] [service_mode] (ip address)"

        return 1;

    fi

    if [ $# -eq 5 ]; then

        dyndns $CLOUDFLARE_EMAIL $CLOUDFLARE_KEY "CREATE" $1 $2 $3 $4 $5

    else

        dyndns $CLOUDFLARE_EMAIL $CLOUDFLARE_KEY "CREATE" $1 $2 $3 $4 

    fi

}

function dns-modift() {

    if [ $# -lt 4 ]; then

        echo "USAGE $0 [domain] [type] [zone_name] [service_mode] (ip address)"

        return 1;

    fi

    if [ $# -eq 5 ]; then

        dyndns $CLOUDFLARE_EMAIL $CLOUDFLARE_KEY "MODIFY" $1 $2 $3 $4 $5

    else

        dyndns $CLOUDFLARE_EMAIL $CLOUDFLARE_KEY "MODIFY" $1 $2 $3 $4 

    fi

}

function dns-delete() {

    if [ $# -lt 4 ]; then

        echo "USAGE $0 [domain] [type] [zone_name] [service_mode] (ip address)"

        return 1;

    fi

    if [ $# -eq 5 ]; then

        dyndns $CLOUDFLARE_EMAIL $CLOUDFLARE_KEY "DELETE" $1 $2 $3 $4 $5

    else

        dyndns $CLOUDFLARE_EMAIL $CLOUDFLARE_KEY "DELETE" $1 $2 $3 $4 

    fi

}

```

## Bugs

I have not fully tested the script, I only tested it with an A record, if you find any bug please open an issue.

### Why I've done this ?

To enjoy myself and to learn some inner aspects of bash. 

# License

DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE

Version 2, December 2004

Copyright (C) 2004 Sam Hocevar 

Everyone is permitted to copy and distribute verbatim or modified

copies of this license document, and changing it is allowed as long

as the name is changed.

DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE

TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

0. You just DO WHAT THE FUCK YOU WANT TO.

# Disclaimer

THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.