From 09ecfbfd17f6678d9382078a165adad53a8614eb Mon Sep 17 00:00:00 2001 From: sij Date: Mon, 7 Oct 2024 08:28:51 +0200 Subject: [PATCH] Update README.md --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8b79a17..88505ab 100644 --- a/README.md +++ b/README.md @@ -84,13 +84,13 @@ Note: If you created the symlink, you can use `cf` instead of `./cf` from any di ## 3. File and Environment Structure -- `Caddyfile`: Caddy server configuration +- `cf`: Wrapper script to activate conda environment and run the Python script +- `cf.py`: Main Python script +- `setup.sh`: Shell script to set up your Conda environment +- `environment.yaml`: Conda environment specification - `cf_domains.yaml`: Stores domain info and DNS record IDs - `.env`: Contains `CLOUDFLARE_API_TOKEN` and `CURRENT_IP` - `cf_script.log`: Logs script actions -- `environment.yaml`: Conda environment specification -- `cf`: Wrapper script to activate conda environment and run the Python script -- `cf.py`: Main Python script ## 4. Key Functions and Error Handling @@ -99,9 +99,10 @@ Note: If you created the symlink, you can use `cf` instead of `./cf` from any di - `update_or_create_record()`: Manages Cloudflare DNS records Common errors: -- API authentication failures: Check API token in `.env` file +- API authentication failures: Check Cloudflare API token in `.env` file - Permission issues: Run with sudo for Caddyfile changes - Domain not found: Ensure domain is in `cf_domains.yaml` +- Caddy failing to obtain HTTPS certificates: Ensure the Caddy service environment contains your CLOUDFLARE_API_TOKEN, and your Caddyfile contains your email address; see Caddy documentation if you have further trouble Logs are in `cf_script.log` for troubleshooting.