Personal Homelab Dashboard for Unraid
๐ฉ๐ช Deutsch | ๐ฌ๐ง English
---
HELDASH is a self-hosted homelab dashboard, purpose-built for [Unraid](https://unraid.net). It runs as a single Docker container and provides a unified interface for services, Docker containers, media automation, Home Assistant, network devices and more โ with a glass morphism UI, no cloud dependency and no subscription.
> โ ๏ธ **Use at Your Own Risk**
>
> This project was developed entirely using AI assistance (Claude Code). It has **not been reviewed by a professional developer**. The code has not been audited for security vulnerabilities, production readiness, or best practices.
>
> **It is explicitly NOT recommended to expose HELDASH publicly on the internet.** The dashboard is designed exclusively for use in local home networks (LAN).
---
## Features
- **Dashboard** โ Modular grid with apps, widgets and bookmarks; drag & drop, collapsible groups, per-user layouts
- **Docker** โ Live container list with CPU/RAM, log streaming, real-time status via Docker Events
- **Home Assistant** โ Multi-instance, entity browser, panel grid, floor plan, GPS tracking, automations, energy dashboard, entity history
- **Media** โ Radarr, Sonarr, Prowlarr, SABnzbd, Seerr/Discover, qBittorrent with statistics, queues and calendars
- **Recyclarr + CF Manager** โ TRaSH Guides sync GUI, custom format editor, import/export
- **Unraid Integration** โ Array & disk overview, cache pools, VM management, notifications, plugins, logs, UPS
- **Network Monitor** โ TCP ping, 7-day history, IP scanner, Wake-on-LAN, device groups
- **Widgets** โ Server stats, AdGuard/Pi-hole, Docker, Nginx PM, HA entities, weather, calendar
- **Icon System** โ 1800+ icons from dashboardicons.com + custom upload, icon picker for all entities
- **Auth & Access** โ Local users, groups (admin, guest, custom), per-group visibility, "remember me"
- **i18n** โ English + German (default); community translations welcome
- **Design** โ Glass morphism, light/dark, 3 accent colors, auto-theme, custom CSS, background images
---
## Installation
### Unraid Community Apps (Recommended)
1. Open the **Apps** tab in Unraid
2. Search for **HELDASH**
3. Click **Install** and follow the template
HELDASH will then be available at `http://SERVER-IP:8282`.
### Docker Compose
```yaml
services:
heldash:
image: ghcr.io/kreuzbube88/heldash:latest
container_name: heldash
restart: unless-stopped
ports:
- "8282:8282"
volumes:
- /mnt/user/appdata/heldash:/data
- /var/run/docker.sock:/var/run/docker.sock:ro
- /mnt/user/appdata/recyclarr:/recyclarr
# - /boot:/boot:ro # optional: CA Backup monitoring
environment:
- SECRET_KEY=your_secret_here # openssl rand -hex 32
- SECURE_COOKIES=false # true if behind HTTPS proxy
```
### Docker CLI
```bash
docker run -d \
--name heldash \
-p 8282:8282 \
-v /mnt/user/appdata/heldash:/data \
-v /var/run/docker.sock:/var/run/docker.sock:ro \
-v /mnt/user/appdata/recyclarr:/recyclarr \
-e SECRET_KEY=$(openssl rand -hex 32) \
-e SECURE_COOKIES=false \
ghcr.io/kreuzbube88/heldash:latest
```
---
## Environment Variables
| Variable | Required | Default | Description |
|---|---|---|---|
| `SECRET_KEY` | **Yes** | insecure | JWT secret. `openssl rand -hex 32` |
| `SECURE_COOKIES` | **Yes** | `false` | `false` = HTTP local, `true` = HTTPS via reverse proxy |
| `PORT` | No | `8282` | Web server listen port |
| `DATA_DIR` | No | `/data` | Database, icons, backgrounds, floor plan images |
| `LOG_LEVEL` | No | `info` | `debug` ยท `info` ยท `warn` ยท `error` |
| `LOG_FORMAT` | No | `pretty` | `pretty` = readable ยท `json` = for log aggregators |
| `RECYCLARR_CONFIG_PATH` | No | `/recyclarr/recyclarr.yml` | Path to recyclarr.yml |
| `RECYCLARR_CONTAINER_NAME` | No | `recyclarr` | Name of Recyclarr Docker container |
| `PUID` | No | `99` | User ID for file permissions (Unraid: 99) |
| `PGID` | No | `100` | Group ID for file permissions (Unraid: 100) |
---
## Prerequisites
- **Docker socket** `/var/run/docker.sock` โ required for Docker integration
- **Data volume** `/data` โ database, icons and configuration
- **Recyclarr volume** `/recyclarr` โ optional, for Recyclarr sync
- **Boot mount** `/boot` โ optional, for CA Backup monitoring
---
## Documentation
Full documentation is available in the [`docs/`](docs/README.md) directory โ in English and German.
---
## Contributing
Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md).
**Especially looking for:**
- ๐ Translations (French, Spanish, Italian, etc.)
- ๐ Documentation improvements
- ๐ Bug reports with reproduction steps
---
## License
MIT ยฉ HEL*Apps