Skip to content

armgit / dashy

Public Imported from GitHub
0

πŸš€ A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!

πŸ“ Adds docs for SW cache busting on proxy auth

Alicia Sykes285a7158f046
diff --git a/docs/authentication.md b/docs/authentication.md
index cbecfae5..60dc44b3 100644
--- a/docs/authentication.md
+++ b/docs/authentication.md
@@ -695,6 +695,7 @@ These are alternatives to Dashy's built-in auth, Keycloak, and OIDC. Most of the
- [Reverse Proxy Auth](#reverse-proxy-auth) - Authelia, Authentik, or similar sitting in front of Dashy
- [Zero-Trust Tunnels](#zero-trust-tunnels) - Cloudflare Tunnel, Tailscale Funnel
+- [Service Worker & Offline Use](#service-worker--offline-use) - Staying logged in with the service worker enabled
- [VPN](#vpn) - Keep Dashy off the internet entirely
- [IP-Based Access](#ip-based-access) - Restrict by source IP in your web server
- [Web Server Authentication](#web-server-authentication) - HTTP basic auth at the proxy level
@@ -726,6 +727,10 @@ These let you expose Dashy to the internet without opening inbound ports or conf
**Tailscale Funnel** exposes Dashy through your Tailscale mesh to the public internet, with automatic TLS. Simpler to set up than Cloudflare but you get less control over access policies. See the [Funnel docs](https://tailscale.com/kb/1223/funnel).
+### Service worker & offline use
+
+If you run Dashy behind any of the redirect-based proxies above and also enable the service worker for offline use (`appConfig.enableServiceWorker: true`), set `appConfig.enableAuthProxyCompat: true` as well. Without it, when your proxy session expires the cached app can get stuck β€” the service worker keeps serving the old page instead of letting the proxy redirect you to its login screen. With it enabled, Dashy detects the expiry on load and reloads so you can sign in again.
+
### VPN
A VPN keeps Dashy off the public internet entirely. You connect to your home network remotely and access Dashy like you're on the LAN. No auth to configure, no attack surface to worry about. The downside: you need the VPN running to see anything, and some networks (corporate WiFi, hotels) block VPN traffic.
diff --git a/docs/authentication/cloudflare-tunnel.md b/docs/authentication/cloudflare-tunnel.md
index db79962c..016f5e2c 100644
--- a/docs/authentication/cloudflare-tunnel.md
+++ b/docs/authentication/cloudflare-tunnel.md
@@ -202,6 +202,10 @@ Solution: The email Cloudflare sends must exactly match a `users[].user` entry w
Problem: Each refresh bounces back through Cloudflare's login.<br>
Solution: Session cookies are being blocked or stripped. Check that the tunnel's public hostname uses HTTPS (it does by default), that no upstream proxy strips third-party cookies, and that the Access application's session duration is non-zero.
+#### Stuck on a cached page after the Access session expires
+Problem: You have the service worker enabled (`appConfig.enableServiceWorker`), and once your Access session expires Dashy keeps showing a broken cached page instead of redirecting to the Cloudflare login.<br>
+Solution: Set `appConfig.enableAuthProxyCompat: true`. Dashy will then detect the expiry on load and reload so Cloudflare can redirect you to log in again.
+
#### "Critical Configuration Load Error" on first load
Problem: SPA errors out before showing the dashboard.<br>
Solution: Usually a CORS or network reachability issue, but for Cloudflare Tunnel this is most often a `cloudflared` to `dashy` networking problem inside Docker. `docker compose logs cloudflared` will show connection attempts. Confirm both services are on the same Docker network and that the tunnel's public hostname URL matches the service name and port (e.g. `dashy:8080`, not `localhost:8080`).