From ee2b49285122e17470d018ba468ed9bd42ffadfa Mon Sep 17 00:00:00 2001 From: Neshura Date: Fri, 29 Dec 2023 00:38:27 +0100 Subject: [PATCH] Updated Readme --- README.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d4ad4bc..fa0e4bd 100644 --- a/README.md +++ b/README.md @@ -7,23 +7,18 @@ The application necessarily requires a valid Cloudflare API Token. Further the application must be located in the same network as the configured zones. -| Environment Variable | Required | Usage | -|:--------------------:|:--------:|:----------------------------------:| -| CF_API_TOKEN | x | Cloudflare API Token | -| STATUS_POST_URL | | Post Endpoint for a Uptime Monitor | -*Note: Variables can be stored in a .env file* - -The actual configuration happens in two or more files: +The actual configuration happens in three or more files: +`config.toml` contains general configuration parameters for the application `interfaces.toml` contains all IPv6 interfaces available/used by the zone config files. `.toml` files in `zone.d` contain settings for individual zones. Example: -*.env* -```text -CF_API_TOKEN=0123456789abcdef0123456789abcdef01234 -CHECK_INTERVAL_SECONDS=30 // Defaults to 60 if missing -UPTIME_URL=https://example.org/uptime/id12 // Entirely optional +*config.toml* +```toml +cf_api_token = "0123456789abcdef0123456789abcdef01234" # Cloudflare API Token +check_interval_seconds = 30 # Defaults to 60 if missing +uptime_url = "https://example.org/uptime/id12" # Post Endpoint for a Uptime Monitor ``` *interfaces.toml*