Get started

Production Configuration

Checklist before using NasDash as a daily dashboard.

Minimal Checklist

  • Persisted keys and any existing NASDASH_JWT_SECRET are retained unchanged.
  • The administrator password and passwords for any reader accounts used for sign-in are unique.
  • Private mode is enabled for sensitive information.
  • Port 2504 is restricted to LAN/VPN or a local reverse proxy.
  • HTTPS and the proxy’s X-Forwarded-Proto: https header are configured for untrusted networks.
  • If a socket proxy is selected, keep it private and use DELETE=0 unless required; Portainer/Dockhand credentials grant only necessary environment permissions.
  • A full /app/data backup and restoration are tested.
  • The previous image tag/digest is kept for rollback.
  • Logs and /api/health are checked after updates.

Reduce Port Exposure

Reverse proxy on the same machine:

ports:
  - "127.0.0.1:2504:2504"

Reverse proxy in the same Docker network: completely remove ports from the NasDash service and use expose: ["2504"]. The proxy must then reach nasdash:2504 via the internal network.

Public or Private Mode

Fresh installations start private. Enabling public mode creates viewer if missing; initially it can read all pages and widgets. Anonymous visitors use its permissions, so review them in Settings → Users and access before opening access.

Public mode does not grant mutations to a visitor, but it can expose services and widgets authorized for the viewer. It does not replace a publication decision. For a personal homelab, private mode behind Tailscale or HTTPS is the most prudent starting point.

Single Instance

NasDash stores its data in JSON files and uses in-memory caches. Do not run multiple replicas that write to the same volume. A serverless or multi-instance deployment is not the supported self-hosted production model.

For request rate limits, forwarded client addresses are ignored by default. Set NASDASH_TRUST_PROXY=true only behind a trusted reverse proxy that overwrites client-supplied forwarding headers and prevents direct access to NasDash. Otherwise keep NASDASH_TRUST_PROXY=false. This setting changes quota identity only; it does not change HTTPS detection or authentication cookie behaviour. Failed-login limits also apply per account, independently of forwarding headers.