diff --git a/README.md b/README.md index c2daf9f..7540b91 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,38 @@ docker pull ghcr.io/akarys42/cloudflare-ddns-docker There are no special requirements when building this container! Simply use `docker build` in this folder. +#### For docker command + +You can use: +``` +docker run --name ddns_client --rm \ +-d ghcr.io/akarys42/cloudflare-ddns-docker \ +-k ${token} \ +mydomain.cat *.mydomain.cat mail.mydomain.cat +``` +or +``` +docker run --name ddns_client --rm \ +-e CF_DDNS_DOMAINS="mydomain.cat *.mydomain.cat mail.mydomain.cat" \ +-e CF_DDNS_TOKEN="${token}" \ +-d ghcr.io/akarys42/cloudflare-ddns-docker +``` +(replacing ${token} by your Cloudflare DNS Edit Permission Token) + +#### For docker-compose users + +``` +version: "3.7" +services: + cloudflare-ddns: + image: ghcr.io/akarys42/cloudflare-ddns-docker + container_name: ddns_client + enviroment: + CF_DDNS_DOMAINS: "mydomain.cat *.mydomain.cat mail.mydomain.cat" + CF_DDNS_TOKEN: "${token}" +``` +(replacing ${token} again) + ### Running on the Host In order to run this project on the host, you'll need Python > 3.8, and an environment containing diff --git a/dev-docker-compose.yaml b/dev-docker-compose.yaml new file mode 100644 index 0000000..c8e76a6 --- /dev/null +++ b/dev-docker-compose.yaml @@ -0,0 +1,8 @@ +## Development docker-compose +version: "3.7" +services: + cloudflare-ddns: + build: + context: . + dockerfile: Dockerfile + container_name: cloudflare-ddns diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..9632da2 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,8 @@ +version: "3.7" +services: + cloudflare-ddns: + image: ghcr.io/akarys42/cloudflare-ddns-docker + container_name: ddns_client + enviroment: + CF_DDNS_DOMAINS: "mydomain.cat *.mydomain.cat mail.mydomain.cat" + CF_DDNS_TOKEN: "${token}" \ No newline at end of file