Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/kdpuvvadi/cf-ddns

Lightweight Docker image for cloudflare DDNS
https://github.com/kdpuvvadi/cf-ddns

cloudflare ddns ddns-client ddns-script docker docker-compose

Last synced: 8 days ago
JSON representation

Lightweight Docker image for cloudflare DDNS

Awesome Lists containing this project

README

        

# Docker Cloudflare DDNS

[![build](https://github.com/kdpuvvadi/cf-ddns/actions/workflows/build.yml/badge.svg)](https://github.com/kdpuvvadi/cf-ddns/actions/workflows/build.yml)

DDNS service for cloudflare

## Creating a Cloudflare API token

To create a CloudFlare API token for your DNS zone go to [https://dash.cloudflare.com/profile/api-tokens](https://dash.cloudflare.com/profile/api-tokens) and follow these steps:

* Click Create Token
* Provide the token a name, for example, cloudflare-ddns
* Grant the token the following permissions:
* `Zone` - `Zone Settings` - `Read`
* `Zone` - `Zone` - `Read`
* `Zone` - `DNS` - `Edit`
* Set the zone resources to:
* Include - All zones

## Deployment

```shell
docker run -d --name ddns \
--restart=always \
-e TOKEN=token \
-e DOMAIN=example.com \
-e CNAME=test \
kdpuvvadi/cf-ddns:latest
```

With `docker-compose`

```yaml
version: "3"

services:
ddns:
container_name: ddns
image: kdpuvvadi/cf-ddns:latest
environment:
TOKEN: 'Token Here'
DOMAIN: 'example.com'
CNAME: 'cname'
restart: unless-stopped
```

## LICENSE

Licensed under [MIT](/LICENSE)