Get started

Prerequisites

Hardware, software, network, and decisions to prepare before installation.

  • A Linux host with Docker Engine and Docker Compose 2.24.0 or newer;
  • Command-line access with the permissions required to run containers;
  • TCP port 2504 available, 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 standard start needs no Docker socket. Only the optional local socket-proxy profile mounts /var/run/docker.sock, a Linux convention. Portainer or Dockhand can be used without that mount; Docker Desktop may need adapted networking. See Docker connections.

Development from Source

  • Node.js 22.x, matching the product’s declared engine and production image;
  • npm with the repository lockfile;
  • Playwright Chromium for browser tests;
  • Docker for image and persistence checks.

Decisions to Make Before First Startup

QuestionRecommended 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 version

The 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.