From 4e26ff135d83b9482559896cd16cba8555c2d3b1 Mon Sep 17 00:00:00 2001 From: Eduard Veit Date: Fri, 23 Apr 2021 18:07:11 +0200 Subject: [PATCH] :memo: document environment variables --- CHANGELOG.md | 11 +++++++++++ README.md | 17 ++++++++++++++++- 2 files changed, 27 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 217fa94..f5c9c29 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,17 @@ # Changelog +## 0.1.2 (2021-04-23) + +### Documentation + +* :memo: document environment variables. [Eduard Veit] + +### Other + +* :recycle: refactor: method extractions and other beautifications. [Eduard Veit] + + ## 0.1.1 (2021-04-23) ### Fix diff --git a/README.md b/README.md index f4f1755..20a3612 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ IPv4 (A) and IPv6 (AAAA) record updates are supported. - [⚙ Configuration](#-configuration) - [🏃 Run](#-run) - [⏰ Cron](#-cron) -- [⏰ docker](#-docker) +- [🐟 docker](#-docker) ## ✨ Update Methods @@ -140,3 +140,18 @@ services: - DYNB_PASSWORD=SuperSecretPassword - DYNB_INTERVAL=60 ``` +## environment variables +| variable | default value | description | +| --------------------- | --------------- | ----------- | +| DYNB_DYN_DOMAIN | undefined | required | +| DYNB_SERVICE_PROVIDER | undefined | required | +| DYNB_UPDATE_METHOD | undefined | required | +| DYNB_IP_MODE | undefined | required | +| DYNB_USERNAME | undefined | the requirement depends on your provider and the update method | +| DYNB_PASSWORD | undefined | the requirement depends on your provider and the update method | +| DYNB_TOKEN | undefined | the requirement depends on your provider and the update method | +| DYNB_INTERVAL | undefined | without this setting the script/docker container will run one time and exits | +| DYNB_DEBUG | undefined | more console outputs | +| DYNB_IPv4_CHECK_SITE | api64.ipify.org | You need a website or Web-API that outputs your remote IP | +| DYNB_IPv6_CHECK_SITE | api64.ipify.org | You need a website or Web-API that outputs your remote IP | +| DYNB_DNS_CHECK_SERVER | 1.1.1.1 | If you are using a local DNS Resolver/Server make sure it answers with the public answer |