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 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 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 your@email.com tokenid CREATE domain.com A example.domain.com 0
./dyndns.sh your@email.com tokenid MODIFY domain.com A example.domain.com 0
./dyndns.sh your@email.com 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 your@email.com 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.

CLOUDFLARE_EMAIL="your@email.com"
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

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

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.

baseboxorg/cloudflare-dns-manager