docs: add installation and maintenance guide

2026-09-24 18:31:43 +02:00
parent 529c6b5982
commit dd13297b5f
7 changed files with 242 additions and 0 deletions
@@ -0,0 +1,59 @@
+# Stelloauth for Home Assistant
+
+Et Home Assistant custom add-on, som kører Stelloauth og CloakBrowser lokalt til
+OAuth-opsætning af integrationen Stellantis Vehicles. Repositoryet understøtter
+`amd64` og `aarch64`.
+
+```text
+Home Assistant Core
+        |
+        | POST http://0031621f-stelloauth:8080/worker
+        v
+--------------------------------------------------+
+| Ét add-on / én container                         |
+|                                                  |
+|  Stelloauth 0.0.0.0:8080                        |
+|          |                                       |
+|          | CDP http://127.0.0.1:9222             |
+|          v                                       |
+|  CloakBrowser 127.0.0.1:9222                    |
+--------------------------------------------------+
+```
+
+Én add-on giver de to processer samme Supervisor-livscyklus og holder
+CloakBrowsers CDP-port på containerens loopback-interface. Add-onen bygges
+lokalt fra kilde, fordi CloakBrowser Binary License ikke tillader, at dette
+repository genudgiver en afledt image med den proprietære CloakBrowser-binær.
+Der publiceres derfor ingen prebuilt images.
+
+## Installation
+
+1. Tilføj
+   `https://git.radixadm.dk/dennis/homeassistant-stelloauth-addon.git` som
+   repository i Home Assistants Tilføjelsesbutik.
+2. Installér **Stelloauth**, aktivér **Start ved opstart** og **Watchdog**, og
+   start add-onen.
+3. Følg den fulde vejledning i [stelloauth/DOCS.md](stelloauth/DOCS.md).
+
+HAOS-installation er ikke gennemført eller påstået som valideret. Målmaskinen
+havde ved inspektionen approximately 4 GB free, mens det lokalt byggede image
+fyldte 2.571 GB; frigør om nødvendigt mere diskplads før installation.
+
+## Fastlåste upstream-kilder
+
+| Komponent | 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` |
+
+Dockerfile og patches er build-opskriften. Supervisor henter det officielle
+CloakBrowser-image og bygger alene et lokalt image til intern brug.
+
+## Licens
+
+Repositoryets eget arbejde er MIT-licenseret; se [LICENSE](LICENSE). Dette
+omfatter ikke CloakBrowsers proprietære binær. Den er fortsat omfattet af den
+separate **CloakBrowser Binary License** og redistribueres ikke af repositoryet.