Get started
Nodvard Deck runs in Docker, whether on a Raspberry Pi 4 or 5 or on an x86-64 machine. You don’t build anything, the ready-made image comes from GitHub (ghcr.io/nodvard/deck, for arm64 and x86-64).
Good to know: the web interface of Nodvard Deck and Nodvard Dock is German only for now. An English interface is planned. This website and the guides are in English.
- Have Docker and Docker Compose ready. A Raspberry Pi needs a 64-bit system.
- Get Deck and start it.
In a terminal
mkdir ~/nodvard-deck && cd ~/nodvard-deck curl -fsSL -o compose.yml https://raw.githubusercontent.com/nodvard/deck/main/deploy/compose.standalone.yml docker compose up -dWhat is in compose.yml?
One container, one port, one volume for the data. No Docker socket, no special privileges. The complete file is on GitHub.
name: nodvard-deck services: nodvard-deck: image: ghcr.io/nodvard/deck:latest restart: unless-stopped ports: - "${NODVARD_DECK_PORT:-8080}:8080" volumes: - nodvard_deck_data:/app/data # Optional: a folder for backups, for example on a NAS # - ./sicherungen:/backups healthcheck: … volumes: nodvard_deck_data: name: nodvard-deck-dataOn Windows, these commands are for WSL or Git Bash. In PowerShell, write
curl.exeinstead ofcurland run the commands one by one. - Open it in your browser:
http://<your-server>:8080. Deck asks for a setup code.docker compose logs nodvard-deckin the same folder shows it, the line starts with “Einrichtungscode”. - Follow the assistant. It guides you through your account and the first server. If you only want to have a look, take the sample data and throw it out later.
Port already in use?
Put a file .env next to compose.yml with the line NODVARD_DECK_PORT=8081 and run docker compose up -d again. Deck is then on port 8081.
Updating
In the same folder, run docker compose pull && docker compose up -d. Your data is kept. Before every update that changes the database, Deck makes a copy of it.
After installing
The first thing you should set up is backups, ideally to a NAS: Back up to a NAS or NFS share. Anything you want to know about the license, data or the Raspberry Pi is in the FAQ.
Other ways
Each way is described step by step in the README:
- Portainer, from the repository or with the web editor
- Raspberry Pi with all commands
- A single
docker runcommand, Podman or Dockge - NAS: Synology, UGREEN, QNAP, Unraid, TrueNAS SCALE, OpenMediaVault, ZimaOS and CasaOS
- Proxmox and Docker Desktop