czm

Cloudflare Zone Manager

This is a Docker image that uses Cloudflare Zone Management to effectively works as a DDNS on top of Cloudflare.

Run on Docker

docker pull golinux/cloudflare-zone-manager

Enviroment Variables

export CONFIG_MAP_PATH=path/to/config/map.yaml
export CONFIG_MOD_PATH=../modules # Default path to built-in modules

Config map

This is a config example for CZM to identify your zones and configurations

cloudflare:
    email: "your@example.com"
    api_key: "YourCloudflareAPIKey"
zones:
    -   id: "0000000000000000000"
        hostname: "example.com"
        dns:
            -   name: "subdomain.example.com"
                dtype: "A"
                proxied: false
                ttl: 120
                rules:
                    not-exist: "create"
                    update: "always"
                module:
                    name: "external-ip"
                    metadata:
                        -   key: "route"
                            data: "eno1"
            -   name: "anothersubdomain.example.comk"
                dtype: "A" 
                content: "10.0.0.1"
                proxied: false
                ttl: 120
                rules:
                    not-exist: "create"
                    update: "always"

Rules

Existent rules are:

• not-exist with keys "create" | "skip"
• update with "always" | "never"

Update its for when CZM found a diff over DNS on Cloudflare and Config Map

Modules

Modules its a tools to create DNSRecord content procedurally

Included modules

• external-ip - This module fetch your external ip to create DDNS Service

For your module can be compatible they need some things

• Main function named as Resolve(args interface{})
• a export named Plugin as type of your module name

Example: modulename.go

package main

type modulename string

func (e modulename) Resolve(args interface{}) (string) {
	return "192.168.0.1"
}

var Plugin modulename

How to build: go build -buildmode=plugin -o modulename.so -o modulename.go

Contributing

Feel free to fork this project and send pull request or open a issue.

Thanks!