diff --git a/README.md b/README.md index 07932dc22..7e5a2c096 100644 --- a/README.md +++ b/README.md @@ -238,6 +238,33 @@ pipx install --python python3.13 "headroom-ai[all]" → [Installation guide](https://headroom-docs.vercel.app/docs/installation) — Docker tags, persistent service, PowerShell, devcontainers. +### Corporate / SSL-inspection environments + +If `pip install "headroom-ai[all]"` fails with `CERTIFICATE_VERIFY_FAILED` +(`unable to get local issuer certificate`), your network uses **SSL inspection** — a MITM +proxy presenting a company-issued CA. The build backend (`maturin`) downloads `rustup` over a +connection your TLS stack doesn't trust. **Install Rust first** so the build doesn't fetch it: + +```bash +# macOS / Linux +curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh && rustup default stable +# Windows +winget install Rustlang.Rustup && rustup default stable +``` + +Restart your shell, then `pip install "headroom-ai[all]"`. A prebuilt wheel avoids the Rust +build entirely where available: `pip install --only-binary headroom-ai headroom-ai`. + +Two runtime assets are fetched over TLS; if they are blocked, trust your corporate CA via +`REQUESTS_CA_BUNDLE` / `SSL_CERT_FILE` / `CURL_CA_BUNDLE`: + +- **`cdn.pyke.io`** — the ONNX Runtime for the Rust core. Alternatively pre-provide it with + `ORT_STRATEGY=system` and `ORT_LIB_LOCATION=/path/to/onnxruntime`. +- **`huggingface.co`** — the `kompress-base` compression model. Pre-download it and run with + `HF_HUB_OFFLINE=1`, or set `HF_ENDPOINT` to a trusted mirror. + +Running with compression disabled (pure gateway) requires neither asset. + ## headroom learn