Files
homeassistant-stelloauth-addon/README.md
T
2026-09-25 10:58:15 +02:00

55 lines
2.5 KiB
Markdown

# Stelloauth for Home Assistant
A Home Assistant app (formerly known as an add-on) that runs Stelloauth and
CloakBrowser locally for OAuth setup of the Stellantis Vehicles integration.
The repository supports `amd64` and `aarch64`.
```text
Home Assistant Core
|
| POST http://0031621f-stelloauth:8080/worker
v
+--------------------------------------------------+
| One app / one container |
| |
| Stelloauth 0.0.0.0:8080 |
| | |
| | CDP http://127.0.0.1:9222 |
| v |
| CloakBrowser 127.0.0.1:9222 |
+--------------------------------------------------+
```
Running both processes in one app gives them the same Supervisor lifecycle and
keeps CloakBrowser's CDP port on the container's loopback interface. The app
builds locally from source because the CloakBrowser Binary License does not
allow this repository to redistribute a derived image containing the
proprietary CloakBrowser binary. No prebuilt images are published.
## Installation
1. Go to **Settings → Apps → Install app → ⋮ → Repositories** and add
`https://git.radixadm.dk/dennis/homeassistant-stelloauth-addon.git`.
2. Install **Stelloauth**, enable **Start on boot** and **Watchdog**, then start
the app.
3. Follow the complete guide in [stelloauth/DOCS.md](stelloauth/DOCS.md).
## Pinned upstream sources
| Component | Version | Commit / OCI index digest |
| --- | --- | --- |
| Stelloauth | `v0.6.0` | `367d4f8c02a3b072c59142c49dffc129edc8548b` |
| Stelloauth image contract | `v0.6.0` | `sha256:51b2194ec9b80cc484d11c016ec5436a12161277a493afdab7078959966d5aa9` |
| CloakBrowser | `0.5.10` | `f04c23da285b3b3d3cf10c8f9d282e7adc1d52ce` / `sha256:2ed5b2d047cbdde22cde7ef1a796526c716aadaa5bccbe1db5ade49282b64a76` |
| Go builder | `1.27.1-bookworm` | `sha256:69a7b9788769bec032d238959b61854e9ae87f57be9029ec04e9885fabf99195` |
| Stellantis Vehicles | `2026.9.4` | `9e0ef96f8fe478af291da4c38c923ada78d0ebf6` |
The Dockerfile and patches define the build. Supervisor downloads the official
CloakBrowser image and builds a local image for internal use only.
## License
The repository's original work is licensed under the MIT License; see
[LICENSE](LICENSE). The proprietary CloakBrowser binary is not included. It
remains subject to the separate **CloakBrowser Binary License**.