Code Monkey home page Code Monkey logo

dicdh's Introduction

dicdh

Dynamic IP Cloudflare DNS Handler (dicdh) is a very simple program that updates the IP of the specified Cloudflare DNS A-records for a given Zone.

Common use case

The ideal use of this software is to install it and configure it to run at startup. Thus, everytime the machine boots, the DNS will be updated.

This is useful for people who don't have a static IP and want some persistent identifier that doesn't change over time. For example, a simple homelab. This way, the same DNS, for example, homelab1.example.com always points to your server, instead of using dynamic IPs that change over time.

Installation

The easiest way to install it is cloning the repository and running the bash scripts in build directory.

  sudo bash ./build/install.sh

This will automatically copy the binary to /usr/bin/ and create a daemon that will run at startup.

Configuration file

You will need to create a file to configure the Cloudflare API key, the DNS' to update, and more.

Create the following file and fill your data.

/etc/dicdh/dicdh.json

{
    "key": "<api key from cloudflare>",
    "zone": "<zone id of the cloudflare domain>",
    "dns": [
        {
            "name": "<full dns>",
            "proxy": "<use cloudflare proxy or not>"
        }
    ]
}

Example configuration file:

{
    "key": "aaaaaaaaaaa111111111",
    "zone": "aaaaaaaaaaa11111111",
    "dns": [
        {
            "name": "test.example.com",
            "proxy": true
        },
        {
            "name": "test2.example.com",
            "proxy": false
        }
    ]
}

How it works

Cloudflare API

It uses the Cloudflare API to update the DNS records. Thus, a valid API key with permissions to edit DNS records is needed.

Authenticating with email is not supported as it is considered insecure and a bad practice.

Public Ip APIs

It uses a list of well-known public APIs to retrieve the client public ip.

dicdh's People

Contributors

ddries avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.