Get started

Quick installation

Install NasDash using the published image and the `./data` folder.

This procedure is suitable for a fresh Linux host. Read the security and backup guides before adding real data.

1. Download the repository

git clone https://github.com/lucas-lepajollec/nasdash.git
cd nasdash

2. Start

# Fresh empty data folder, default container UID:GID only
mkdir -p data
sudo chown 1001:1001 data
sudo chmod 700 data
docker compose up -d
docker compose ps

No .env is required. NasDash persists its cryptographic keys and prints one administrator setup code, in the form Setup code: XXXX-XXXX-XXXX, once in the service logs. A fresh installation is private and creates no viewer account.

Open http://192.0.2.10:2504 from your private network, replacing the example address with your server. Enter the setup code on the first-start screen, or your NASDASH_ADMIN_PASSWORD if configured. Follow the five-step guide to choose a new password and build Home.

3. Verify and retrieve the setup code

curl --fail http://127.0.0.1:2504/api/health
docker compose logs nasdash

For an existing folder, Synology ACLs or a custom UID:GID, follow installation and permissions before starting.

Docker management is optional. Choose Portainer, Dockhand, an HTTP(S) Docker-compatible API, or a Unix socket. The local socket proxy is one option; Portainer and Dockhand do not require it. See Docker connections.

The default command starts NasDash alone. For the optional local proxy, run the command below, then choose Address in Settings → Integrations → Docker. Enter docker-proxy in the host field and 2375 in the port field; the resulting endpoint is http://docker-proxy:2375. Keep the profile enabled on recreates and preserve the existing data mount.

docker compose --profile docker-proxy up -d
Docker address / host  docker-proxy
Docker API port        2375

4. Back up

Before any significant configuration, follow Back up and keep an archive off the Docker host.