Synk fra arbeidsrepoet

README.md

@@ -1,40 +1,41 @@
-# Vaultnord — preg på hvelvene
+# Vaultnord — hvelv-image
 
 Vaultnord drifter passordhvelv basert på
 [Vaultwarden](https://github.com/dani-garcia/vaultwarden), som er fri programvare
-under **AGPL-3.0**.
+under **AGPL-3.0**. Vi kjører en lett endret utgave, og AGPL krever at endringene
+er tilgjengelige for dem som bruker tjenesten. Her er de.
 
-Dette repoet inneholder alt vi legger *utenpå* hvelvet: en nginx-mellomtjener som
-syr inn vår egen CSS, favicon og en bunntekst med kildekodelenke.
+## Hva som er endret
 
-## Hvorfor det ligger utenfor programmet
+Ingenting i selve serverkoden. Vi bygger fra det offisielle imaget og legger til
+statiske filer i den ferdigbygde web-klienten:
 
-Vaultwarden kjører hos oss **uendret**, i offisielle utgivelser. Skulle vi
-rebrandet ved å patche web-klienten, måtte den bygges på nytt for hver
-oppstrømsversjon — og da blir en sikkerhetsfiks til en byggejobb i stedet for en
-tag-endring. Ved å legge preget på i en mellomtjener er oppgradering fortsatt
-bare å bytte image.
+- vår CSS, som bytter logo, farger og illustrasjonsfarger
+- våre ikoner, som erstatter klientens favicon
+- en bunntekst som lenker til denne kildekoden
+- en side med lisens- og kildekodeinformasjon
 
-Det gir også et ryddigere lisensbilde: vi endrer ikke programmet, og hvelvet du
-snakker med er identisk med det oppstrøms utgir.
+`index.html` får to ekstra linjer: en `<link>` til CSS-en og bunnteksten.
+Web-klienten bygges ikke om, og ingen Angular- eller Rust-kode røres.
+
+Konsekvensen er at oppgradering er å bytte `VW_VERSION` og bygge på nytt. En
+sikkerhetsfiks fra oppstrøms skal ikke være en byggejobb.
+
+## Bygge selv
+
+    docker build --build-arg VW_VERSION=alpine --build-arg BRAND_DIR=brand -t vaultnord/vault .
 
 ## Kildekode
 
 | | |
 |---|---|
 | Vaultwarden, original | https://github.com/dani-garcia/vaultwarden |
-| Vaultwarden, vår kopi | https://git.skui.io/vaultnord.no/vaultwarden |
+| Vaultwarden, vårt speil | https://git.skui.io/vaultnord.no/vaultwarden |
 | Dette repoet | https://git.skui.io/vaultnord.no/vaultnord-brand |
 
-Vaultnord-panelet — der kunder administrerer brukerne sine — er et selvstendig
-program som snakker med hvelvet over HTTP-API. Det er ikke avledet av
-Vaultwarden, og deles ikke under AGPL.
+## Hva som ikke er her
 
-## Innhold
-
-    brand-proxy/nginx.conf        mellomtjeneren
-    brand-proxy/static/brand.css  fargene og bunnteksten
-    brand-proxy/static/kilde.html siden hvelvets bunntekst peker til
-
-Lisens for innholdet i dette repoet: se `brand-proxy/`. Vaultwarden selv er
-AGPL-3.0, og lisensteksten følger med i kildekoderepoene over.
+Vaultnord-panelet — nettsiden og styringsflaten der kunder administrerer
+brukerne sine — er et selvstendig program som snakker med hvelvet over
+HTTP-API. Det er ikke avledet av Vaultwarden, deler ingen kode med det, og
+faller derfor ikke inn under AGPL. Det er lukket.