sij/cf
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Sangye Ince-Johannsen 2024-10-07 08:28:51 +02:00
parent 460f33801f
commit 09ecfbfd17
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -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 ## 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 - `cf_domains.yaml`: Stores domain info and DNS record IDs
- `.env`: Contains `CLOUDFLARE_API_TOKEN` and `CURRENT_IP` - `.env`: Contains `CLOUDFLARE_API_TOKEN` and `CURRENT_IP`
- `cf_script.log`: Logs script actions - `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 ## 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 - `update_or_create_record()`: Manages Cloudflare DNS records
Common errors: 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 - Permission issues: Run with sudo for Caddyfile changes
- Domain not found: Ensure domain is in `cf_domains.yaml` - 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. Logs are in `cf_script.log` for troubleshooting.