Get started
Prerequisites
Hardware, software, network, and decisions to prepare before installation.
Recommended Docker Installation
- A Linux host with Docker Engine and Docker Compose
2.24.0or newer; - Command-line access with the permissions required to run containers;
- TCP port
2504available, or another chosen host port; - Persistent storage for the entirety of
/app/data; - Network access from the NasDash container to the target integrations;
- A backup strategy separate from the primary disk or volume.
The provided Compose file mounts /var/run/docker.sock, a Linux convention. Docker Desktop can run NasDash, but local Docker access must be adapted, and this is not the path validated by the provided file.
Development from Source
- Node.js
20.9.0or newer; - Node.js 22 LTS recommended, identical to the current production image;
- npm with the repository's lockfile;
- Playwright Chromium only if you run browser tests;
- Docker if you validate the image and persistence.
Decisions to Make Before First Startup
| Question | Recommended Choice |
|---|---|
| Where to store data? | ./data by default; named volume only as an optional new-install alternative |
| Who can see the dashboard? | Private mode for an instance containing sensitive information |
| Remote access? | Tailscale or HTTPS reverse proxy; do not publish port 2504 directly to the Internet |
| Docker actions? | Keep POST=1 only if necessary and DELETE=0 by default |
| Initial secret? | Let NasDash generate and persist it, or provide one explicitly for an advanced deployment |
Verify Docker Compose
docker version
docker compose versionThe second command must report Compose 2.24.0 or newer. This version supports the optional .env used by the copy-ready configuration. The historical syntax docker-compose is not the one used by the guides.