lobo/wttr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

update configuration in readme

Browse source
This commit is contained in:
Emil Lerch 2026-01-06 18:34:00 -08:00
parent 35c9831ba8
commit 9ccb0b2cb2
Signed by: lobo
GPG key ID: A7B62D657EF764F8
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -225,18 +225,20 @@ All configuration is via environment variables:
| `WTTR_CACHE_DIR` | `~/.cache/wttr` | Cache directory | | `WTTR_CACHE_DIR` | `~/.cache/wttr` | Cache directory |
| `WTTR_CACHE_SIZE` | `10000` | Max cached responses | | `WTTR_CACHE_SIZE` | `10000` | Max cached responses |
| `WTTR_GEOLITE_PATH` | `~/.cache/wttr/GeoLite2-City.mmdb` | GeoIP database path | | `WTTR_GEOLITE_PATH` | `~/.cache/wttr/GeoLite2-City.mmdb` | GeoIP database path |
| `WTTR_GEOCACHE_FILE` | `~/.cache/wttr/geocache.json` | Location name cache |
| `IP2LOCATION_API_KEY` | (none) | Optional IP geolocation fallback | | `IP2LOCATION_API_KEY` | (none) | Optional IP geolocation fallback |
| `IP2LOCATION_CACHE_FILE` | `~/.cache/wttr/ip2location.cache` | IP2Location cache file |
| `METNO_TOS_IDENTIFYING_EMAIL` | (none) | Email for Met.no API identification |
## External Services ## External Services
### Required (No API Key) ### Required
- **Met.no Weather API** - Weather data provider (free, no registration) - **Met.no Weather API** - Weather data provider (free, no registration)
- Set METNO_TOS_IDENTIFYING_EMAIL to identify yourself to Met.No - Set METNO_TOS_IDENTIFYING_EMAIL to identify yourself to Met.No
- **IP2Location.io** - IP geolocation service
- **IP2Location.io** - Fallback IP geolocation
- Sign up at https://www.ip2location.io/ - Sign up at https://www.ip2location.io/
- Free tier: 30,000 requests/month - Free tier: 30,000 requests/month
- Set via `IP2LOCATION_API_KEY` environment variable - Set `IP2LOCATION_API_KEY` environment variable for higher limits
### Auto-Downloaded ### Auto-Downloaded
- **MaxMind GeoLite2 City** - IP geolocation database - **MaxMind GeoLite2 City** - IP geolocation database