gortium/openconcho
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: scrub environment-specific endpoint from proxy spec

Browse Source 
Replace the real tailnet hostname and IP with honcho.example.net / a generic
tailnet reference — specs and PRs should carry examples, not live endpoints.
This commit is contained in:
Offending Commit
2026-06-02 15:05:25 -05:00
parent 3ea6a73833
commit 08b77839b1
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/superpowers/specs/2026-06-02-honcho-api-proxy-design.md
View File

@@ -10,7 +10,7 @@
The web build (`@openconcho/web`) talks to Honcho directly from the browser. When The web build (`@openconcho/web`) talks to Honcho directly from the browser. When
the configured instance URL is a different origin than the page (e.g. a self-hosted the configured instance URL is a different origin than the page (e.g. a self-hosted
Honcho at `https://honcho.hydra-capella.ts.net` while the UI runs on Honcho at `https://honcho.example.net` while the UI runs on
`http://localhost:8080`), the browser issues a CORS preflight on the `Authorization` `http://localhost:8080`), the browser issues a CORS preflight on the `Authorization`
header and the request fails — Honcho ships no `CORSMiddleware`. header and the request fails — Honcho ships no `CORSMiddleware`.
@@ -23,12 +23,12 @@ the moment a user typed an absolute URL into Settings — which is the bug that
### Evidence gathered ### Evidence gathered
- Browser → `honcho.hydra-capella.ts.net` is reachable; the CORS error proves the - Browser → `honcho.example.net` is reachable; the CORS error proves the
request reached Honcho and only the browser policy check failed. request reached Honcho and only the browser policy check failed.
- A Docker container under Colima **also** reaches the tailnet: `docker run ... - A Docker container under Colima **also** reaches the tailnet: `docker run ...
curl https://honcho.hydra-capella.ts.net/health` returned **HTTP 200**, connected curl https://honcho.example.net/health` returned **HTTP 200**, connected over the
to `100.72.133.27:443` with TLS verified. So a container-side proxy is viable on tailnet on `:443` with TLS verified. So a container-side proxy is viable on this
this host (Colima forwards container egress through the host's tailnet routing). host (Colima forwards container egress through the host's tailnet routing).
## Decisions ## Decisions
@@ -53,15 +53,15 @@ the moment a user typed an absolute URL into Settings — which is the bug that
``` ```
WEB (docker + dev): WEB (docker + dev):
browser ──same-origin──▶ /api/v3/... (openapi-fetch base = "/api") browser ──same-origin──▶ /api/v3/... (openapi-fetch base = "/api")
X-Honcho-Upstream: https://honcho.hydra-capella.ts.net (from instance.baseUrl) X-Honcho-Upstream: https://honcho.example.net (from instance.baseUrl)
Authorization: Bearer … (unchanged, when set) Authorization: Bearer … (unchanged, when set)
│ proxy: validate header, allowlist-check, strip "/api", │ proxy: validate header, allowlist-check, strip "/api",
│ proxy_pass $upstream, set SNI/Host, drop routing header │ proxy_pass $upstream, set SNI/Host, drop routing header
▼ ▼
https://honcho.hydra-capella.ts.net/v3/... (server-side hop — no CORS) https://honcho.example.net/v3/... (server-side hop — no CORS)
TAURI: TAURI:
webview ──reqwest──▶ https://honcho.hydra-capella.ts.net/v3/... (unchanged) webview ──reqwest──▶ https://honcho.example.net/v3/... (unchanged)
``` ```
**Why a custom header is free here:** `X-Honcho-Upstream` rides a *same-origin* **Why a custom header is free here:** `X-Honcho-Upstream` rides a *same-origin*
@@ -156,7 +156,7 @@ the docker image (local/CI parity).
`src/lib/runtimeConfig.ts`. `src/lib/runtimeConfig.ts`.
- **Retire `HONCHO_UPSTREAM`** from compose — the upstream now comes from the header. - **Retire `HONCHO_UPSTREAM`** from compose — the upstream now comes from the header.
- New optional `OPENCONCHO_UPSTREAM_ALLOWLIST` (comma-separated host globs, e.g. - New optional `OPENCONCHO_UPSTREAM_ALLOWLIST` (comma-separated host globs, e.g.
`honcho.hydra-capella.ts.net,*.honcho.dev`). The entrypoint renders it into the `honcho.example.net,*.honcho.dev`). The entrypoint renders it into the
nginx `map` for `$allow_upstream`; unset ⇒ map default 1. nginx `map` for `$allow_upstream`; unset ⇒ map default 1.
## Data flow (Fleet aggregation, web mode) ## Data flow (Fleet aggregation, web mode)