mirror of
https://github.com/bilawalsidhu/gods-eye-view.git
synced 2026-11-04 10:24:02 +00:00
Bilawal Sidhu
b6da93b8ac
The first formal release. - One-click install via Pinokio; keyless boot lands on a live Esri World Imagery satellite globe with keyless terrain, with automatic OSM fallback and graceful degradation when terrain is unavailable. - Provider Settings (the POWER UP panel): add, replace, or remove API keys inside the app; credential files made owner-only before any secret is written; external keys shown read-only; the panel refuses shared or proxied servers. - Keyless capability responses for the optional HUD summary and place search. - Aircraft-identity voice answers cover operator, type, and route, and say so plainly when enrichment is unavailable. - README rewritten keyless-first; concise 0.1.0 changelog section; CI workflow included. Gates: 2,672 unit tests pass / 0 fail, build clean, tracking regression 108/108, map-source tray QA pass, setup doctor ready.
67 lines
1.6 KiB
Markdown
67 lines
1.6 KiB
Markdown
# OpenSky Auth Setup
|
|
|
|
God's Eye View uses explicit auth modes for `/api/opensky`:
|
|
|
|
- `OPENSKY_AUTH_MODE=oauth` (default, recommended)
|
|
- `OPENSKY_AUTH_MODE=auto` (OAuth first, then Basic fallback)
|
|
- `OPENSKY_AUTH_MODE=basic`
|
|
- `OPENSKY_AUTH_MODE=anon`
|
|
|
|
Reference: OpenSky REST API docs recommend OAuth2 Client Credentials flow.
|
|
|
|
## Quick Start (OAuth Client JSON)
|
|
|
|
Import credentials from JSON (`clientId`/`clientSecret` or `client_id`/`client_secret`) into Keychain:
|
|
|
|
```bash
|
|
./scripts/opensky-import-client.sh ~/Downloads/credentials.json
|
|
# or: npm run opensky:import -- ~/Downloads/credentials.json
|
|
```
|
|
|
|
Then launch:
|
|
|
|
```bash
|
|
./scripts/dev-fresh.sh
|
|
```
|
|
|
|
Expected startup lines:
|
|
|
|
- `OpenSky auth mode: oauth`
|
|
- `OpenSky OAuth: configured`
|
|
|
|
## Optional: Launch With File (No Keychain Import)
|
|
|
|
```bash
|
|
OPENSKY_CREDENTIALS_FILE=~/Downloads/credentials.json ./scripts/dev-fresh.sh
|
|
```
|
|
|
|
Launchers resolve OAuth creds in this order:
|
|
|
|
1. `OPENSKY_CLIENT_ID` + `OPENSKY_CLIENT_SECRET`
|
|
2. `OPENSKY_CREDENTIALS_FILE`
|
|
3. Keychain (`opensky-network` / `client_id`, `client_secret`)
|
|
|
|
## Basic Auth (Legacy)
|
|
|
|
Basic auth is still supported for now, but OpenSky is moving away from it.
|
|
|
|
```bash
|
|
OPENSKY_AUTH_MODE=basic ./scripts/dev-fresh.sh
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
Inspect proxy headers:
|
|
|
|
```bash
|
|
curl -si http://localhost:4173/api/opensky | grep -iE 'HTTP/|X-OpenSky-Auth'
|
|
```
|
|
|
|
Useful reasons:
|
|
|
|
- `oauth_invalid_or_missing`: OAuth client not found/usable
|
|
- `oauth_invalid_credentials`: OAuth client rejected by OpenSky
|
|
- `basic_invalid_credentials`: username/password rejected
|
|
- `missing_basic_creds`: basic mode missing user/pass
|
|
- `rate_limited`: OpenSky throttling
|