docs(#2781): document proxy auth PWA update caveat - #5673
1 commit merged into
Conversation
|
| Filename | Overview |
|---|---|
| README.md | Adds a single bullet in the Authentication section warning about proxy basic auth + installed PWA interaction; pointer to troubleshooting uses a bare backtick path instead of a markdown hyperlink. |
| docs/onboarding.md | Expands the Password step with a paragraph recommending WebUI's built-in password over proxy basic auth for installed PWAs; technically accurate and follows the existing prose style. |
| docs/troubleshooting.md | Adds a new 'Installed PWA opens to a blank screen after an update' section with Symptom/Why/Diagnostic/Fix/When-to-file-a-bug structure matching the existing file conventions; content is accurate and actionable. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Installed PWA opens after WebUI update] --> B{Blank screen?}
B -- No --> Z[No action needed]
B -- Yes --> C[Open same URL in normal browser tab]
C --> D{Loads in tab?}
D -- No --> E[Broader WebUI issue — file bug]
D -- Yes --> F[Check proxy logs for 401 on sw.js / manifest.json / static/*]
F --> G{401s found?}
G -- No --> H[Blank screen without proxy auth? → file WebUI bug]
G -- Yes --> I[Mitigation: use WebUI built-in password\nOR scope proxy auth to allow SW fetches]
I --> J{Already blank shell?}
J -- Yes --> K[Clear site data for Hermes origin\nThen reopen / reinstall PWA]
J -- No --> L[Next update completes cleanly]
K --> L
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
A[Installed PWA opens after WebUI update] --> B{Blank screen?}
B -- No --> Z[No action needed]
B -- Yes --> C[Open same URL in normal browser tab]
C --> D{Loads in tab?}
D -- No --> E[Broader WebUI issue — file bug]
D -- Yes --> F[Check proxy logs for 401 on sw.js / manifest.json / static/*]
F --> G{401s found?}
G -- No --> H[Blank screen without proxy auth? → file WebUI bug]
G -- Yes --> I[Mitigation: use WebUI built-in password\nOR scope proxy auth to allow SW fetches]
I --> J{Already blank shell?}
J -- Yes --> K[Clear site data for Hermes origin\nThen reopen / reinstall PWA]
J -- No --> L[Next update completes cleanly]
K --> L
Reviews (1): Last reviewed commit: "docs(#2781): document proxy auth PWA upd..." | Re-trigger Greptile
|
🔬 Gate certification — GREEN ✅ (docs-only, light gate) Certified head: Docs-only (README.md + docs/onboarding.md + docs/troubleshooting.md, +21/-0, zero code) → light gate: content-accuracy + link/markdown sanity, no Codex/Fable/full-suite needed.
Ready to merge — branch |
426f12c
Thinking Path
static/sw.jsalready keeps service-worker updates, login assets, API/health, and navigations on live network paths, so the remaining gap is operator guidance for reverse-proxy basic-auth deployments rather than a WebUI code change.What Changed
README.md: add a short authentication caveat for installed PWAs behind reverse-proxy basic auth, with a pointer to troubleshooting.docs/onboarding.md: expand the Password step so reverse-proxy deployments know when to prefer the built-in WebUI password and why.docs/troubleshooting.md: add a blank-screen-after-update diagnostic flow covering proxy401checks, practical mitigations, and site-scoped cleanup.Why It Matters
Operators keep reverse-proxy support, but they get a clear warning about the one auth layering that can strand an installed PWA on a blank shell after updates. That turns a confusing "clear everything" failure into a specific config choice and a recoverable cleanup path.
Verification
rg -n "reverse proxy|basic auth|WebUI password|PWA|blank screen|site data" README.md docs/onboarding.md docs/troubleshooting.mdgit diff --check HEAD^ HEADREADME.md,docs/onboarding.md, anddocs/troubleshooting.mdsections together to confirm they preserve reverse-proxy support, recommend the built-in WebUI password for installed PWAs behind proxy basic auth, and include site-scoped recovery steps for an already blank shell.Upstream
Closes #2781.
Model Used
GPT 5.5 via Codex CLI