The live homelab dashboard: actions on the cards, boards for the desk, the phone and the wall.
6.0K
The live homelab dashboard. Cards that move, actions on the cards, boards for the desk, the phone and the wall.
nexdeck belongs to the nexapps family, next to Nexview, nexcrate, nexpaper, nexmail, nexpulse and more. Every one of them has cards on the board.

/go/<name>, Ctrl+K or nexdeck as the search engine of your browser opens a tile by its short name, also a tile that only follows a connection.data/boards/ to provision it. Docker labels create tiles.Every card is a widget of one integration, dropped on a free grid and sized by hand. A template is only where you begin.
What is playing, what the library holds, what is on its way in, and the covers of what arrived last. And your own music: a player card plays the library of Plex, Jellyfin or Emby in the browser, keeps playing from board to board, and edits playlists on the server.

The same grid, a different question. Hosts, containers, pools, disks, certificates and what answers.

A page of its own kind: the plan of a UniFi network, read from the console you already connected. Each link carries its traffic as dots or dashes in both directions, coloured by load, with the age of the value beside it. Click a device to light up its way to the internet and see its ports. Servers, the NAS and other wired devices join from a list; whatever the console finds later waits under Found until you place it. On a phone the plan becomes an indented list. UniFi only for now; SNMP is next.

A third kind of page, for Home Assistant and a beta for now: the controls of your home on a free surface instead of the card grid, so a light switch takes the room of a light switch. Put headings over your rooms, place everything where you like it, and grow or shrink a drawing by its corner. Pick from lists that leave out what does not belong on a wall (settings, diagnostics, anything hidden in Home Assistant):
Every element can carry a name of its own, keeps its place when it is renamed in Home Assistant, and follows the card style under Appearance, liquid glass and tilt included. On a phone every heading keeps its elements under it, and on a wall display the page switches when its kiosk link allows actions. The lists are read from Home Assistant's registry, which it shows only to an administrator, so the connection needs a long-lived token of one.

A kiosk link opens one board without a sign-in, read-only unless you say otherwise. It cycles through the pages and dims at night. The token is handed in once at the door and never rides in an address afterwards.

mkdir nexdeck && cd nexdeck
curl -fsSL https://raw.githubusercontent.com/DerKezorm/nexdeck/main/docker-compose.yml -o docker-compose.yml
docker compose up -d
Open http://your-host:5175. The first start creates the administrator and offers a demo board with invented, moving data, so you can look around before connecting anything.
Mount /var/run/docker.sock (already in the compose file) to see this host's containers, act on them and follow their logs. On Synology the same socket serves Container Manager.
| Variable | Default | Purpose |
|---|---|---|
NEXDECK_SECRET_KEY | generated into /data/secret.key | Encrypts stored API keys and signs sessions. Set it once and keep it. |
NEXDECK_PUBLIC_URL | empty | How browsers reach nexdeck. Needed for OpenID Connect and Web Push. |
NEXDECK_DEMO | 0 | Start every widget with invented data. |
NEXDECK_LOG_LEVEL | INFO | DEBUG logs every adapter request. |
NEXDECK_ALLOW_LOOPBACK_TARGETS | 0 | Let notification channels, Web Push, RSS cards and reachability checks call 127.0.0.1. Connections an administrator made are never affected. |
NEXDECK_UPLOAD_QUOTA_MB | 200 | What one account may leave lying in /data/uploads. 0 means no ceiling. |
NEXDECK_KEEP_ACTION_LOG_DAYS | 90 | How long the record of who pressed what is kept. 0 keeps it forever. |
NEXDECK_KEEP_NOTICES_DAYS | 90 | How long messages in the notice centre are kept. |
NEXDECK_KEEP_OUTAGES_DAYS | 365 | How long finished outages are kept, and maintenance that is over. A running one is never swept. |
NEXDECK_KEEP_EVENTS_DAYS | 365 | How long the lines of the chronicle are kept. |
NEXDECK_WORKSHOP_TOKEN | empty | Only for a private copy of the Workshop: a key that may read that repository. The public Workshop needs none. |
NEXDECK_WORKSHOP_CLIENT_ID | the Client ID of the "nexdeck Workshop" GitHub App | The public Client ID used to sign administrators in to GitHub when they share a card. There is no secret to go with it. |
PUID, PGID | 1000 | Owner of the files in the data volume. |
DOCKER_GID | detected | Group of the mounted Docker socket, when detection fails. |
Rarely needed, but real:
| Variable | Default | Purpose |
|---|---|---|
NEXDECK_DATA_DIR | /data | Where the database, the key file, uploads and caches live. |
NEXDECK_STATIC_DIR | set in the image | The built frontend. Empty means the API only. |
NEXDECK_COOKIE_SECURE | auto | auto sets the Secure flag when the request came over HTTPS, directly or from a proxy named in NEXDECK_TRUSTED_PROXIES; always and never force it. |
NEXDECK_SESSION_DAYS | 30 | Days a browser stays signed in without activity. |
NEXDECK_BCRYPT_ROUNDS | 12 | Cost of a password hash. Lower is faster and weaker. |
NEXDECK_DB_POOL_SIZE | 20 | Database connections held open. |
NEXDECK_DB_MAX_OVERFLOW | 20 | How many more may be opened under load. |
NEXDECK_REQUEST_THREADS | 24 | Worker threads for synchronous routes. Keep it below the two above added together. |
NEXDECK_HISTORY_RAW_HOURS | 1 | How long raw samples are kept before they become minute averages. |
NEXDECK_HISTORY_MINUTE_HOURS | 24 | How long those minute averages are kept. |
NEXDECK_HISTORY_HOUR_DAYS | 90 | How long hour averages are kept, with their lowest and highest: charts of 7 and 30 days and the forecasts read them. |
NEXDECK_HISTORY_DAY_DAYS | 730 | How long day averages are kept: a chart of a year. |
NEXDECK_LOG_HISTORY_HOURS | 6 | How long container log lines are kept. |
NEXDECK_HEALTH_INTERVAL_SECONDS | 30 | Default interval for reachability checks. |
NEXDECK_OUTAGE_THRESHOLD_SECONDS | 120 | How long a service must be down before an outage is announced. |
NEXDECK_ICON_CACHE_DAYS | 30 | How long a fetched logo is kept. |
NEXDECK_UPDATE_CHECK | 0 | Ask GitHub whether a newer nexdeck exists, and for the newest releases of the connected services. Off by default: it is an outbound call, and the projects asked about tell GitHub which services run here. Also under System, About. |
NEXDECK_CORS_ORIGINS | empty | Origins allowed to call the API from a browser. * is refused at start-up, because with credentials it would let any site act as the signed-in user. |
NEXDECK_BACKUP_EVERY_HOURS | 24 | How often a snapshot is written by itself. 0 switches it off. |
NEXDECK_TRUSTED_PROXIES | empty | Addresses or networks of the reverse proxies in front of nexdeck, comma separated. Their X-Forwarded-For is believed when nexdeck decides whether a browser is on the home network; without it, a forwarded request is never signed in automatically. It is also the only list whose X-Forwarded-Proto is believed for the Secure flag of cookies and whose X-Forwarded-Proto and X-Forwarded-Host the sign-in believes for its redirect address; empty, nobody's is (see below). |
A guard test keeps this table in step with the settings in the code.
nexdeck speaks plain HTTP on port 8000. It believes X-Forwarded-Proto only from a proxy named in NEXDECK_TRUSTED_PROXIES, and out of the box from nobody: then the scheme is the one the request really came in on, so a visitor cannot choose it. Of a named proxy the right-most value of the last header line counts (the one the nearest proxy wrote), http or https in any case. That scheme decides the Secure flag of the cookies. Behind a proxy that ends TLS, name it in NEXDECK_TRUSTED_PROXIES, or set NEXDECK_COOKIE_SECURE=always; otherwise the cookies go without the Secure flag (until 0.39.0 every sender's header was believed for it). The redirect address the sign-in sends to a provider: with a public address set (System → Sign-in) that address is used and no header is read; without one, scheme and host come from X-Forwarded-Proto and X-Forwarded-Host by the same rule, so a visitor cannot make the sign-in send a provider an address of their choosing. Without a named proxy the sign-in uses the address the request really came in on. This is the setting the authentik card means when it warns that the server sees a request as http: name your proxy, or set the public address. Server-Sent Events need a proxy that does not buffer: for nginx, proxy_buffering off; on the location; Traefik and Caddy need nothing.
Under System → Sign-in an administrator adds OpenID Connect providers (each gets a button on the sign-in page, in the order of the list), sets authentik up in one step with a one-time API token, or downloads a blueprint instead. Microsoft Entra ID takes https://login.microsoftonline.com/common/v2.0 (or organizations, or a tenant) as the issuer. A provider's redirect address is <public address>/api/v1/oidc/<short name>/callback; providers set up with nexdeck 0.36 or older keep /api/v1/auth/oidc/<short name>/callback, which their provider already knows. Accounts are found by the provider's subject only, never by an e-mail address; people link their own account under Profile, with their password. Password sign-in can be switched off once a provider is active; administrators can always use their password.
Signing in on the home network (System → Home network) needs the browser's real address. Behind a proxy, name the proxy in NEXDECK_TRUSTED_PROXIES; the page shows what nexdeck makes of your own address. The image starts uvicorn with --no-proxy-headers and reads the forwarding headers itself; a compose file that overrides the command should do the same.
The full README is on GitHub: https://github.com/DerKezorm/nexdeck#readme
Content type
Image
Digest
sha256:235f3caf0…
Size
95.2 MB
Last updated
about 6 hours ago
docker pull derkezorm/nexdeck