This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Configuración Inicial

Guía para configurar Heimdall tras el primer despliegue, independientemente del modo usado (Traefik, NPM, o Standalone).

🎯 Primer Acceso

Al abrir Heimdall por primera vez verás una interfaz vacía con mensaje de bienvenida.

Activar Modo Edición

Click en el icono de llave inglesa 🔧 (esquina superior derecha)
La interfaz cambia a modo edición (fondo con cuadrícula)

➕ Añadir Primera Aplicación

Ejemplo: Añadir Portainer

Click en Add Application (botón grande en el centro)
Rellenar formulario:

Campos básicos:

Application name: Portainer
Colour: #13bef9 (azul Portainer)
Icon: Buscar portainer en el selector
URL: https://portainer.tudominio.com (o IP:puerto si standalone)
Description: Gestión de contenedores Docker

Opciones adicionales (opcional):

Pinned: ✅ (mantiene la app al inicio)
Open in new window: ✅ (abre en nueva pestaña)

Click en Save 💾

La aplicación aparece como tarjeta en el dashboard.

🎨 Añadir Más Aplicaciones

Aplicaciones Comunes

Proxmox

Name: Proxmox
Colour: #E57000
Icon: proxmox
URL: https://proxmox.tudominio.com:8006
Description: Virtualización y contenedores

Jellyfin

Name: Jellyfin
Colour: #00A4DC
Icon: jellyfin
URL: https://jellyfin.tudominio.com
Description: Servidor multimedia

Home Assistant

Name: Home Assistant
Colour: #41BDF5
Icon: home-assistant
URL: https://homeassistant.tudominio.com
Description: Domótica

Pi-hole

Name: Pi-hole
Colour: #96060C
Icon: pi-hole
URL: https://pihole.tudominio.com/admin
Description: Bloqueador DNS

qBittorrent

Name: qBittorrent
Colour: #3889CE
Icon: qbittorrent
URL: https://qbittorrent.tudominio.com
Description: Cliente torrent

🔌 Enhanced Apps - Widgets Especiales

Heimdall soporta widgets avanzados para apps populares que muestran información en tiempo real.

Configurar Enhanced App

Ejemplo: Sonarr

Click en engranaje ⚙️ de la aplicación
Enable: ✅ Marcar checkbox
Application type: Seleccionar Sonarr
Enhanced options (se expande):
- API Key: Ir a Sonarr → Settings → General → API Key (copiar)
- Pegar en Heimdall
Save

El widget ahora muestra:

Próximos episodios
Series monitorizadas
Actividad de descargas

Enhanced Apps Disponibles

Aplicación	Muestra
Plex	Streams activos, películas/series
Sonarr	Próximos episodios, series
Radarr	Próximas películas, biblioteca
Lidarr	Próximos lanzamientos, artistas
SABnzbd	Cola de descargas, velocidad
NZBGet	Cola, historial
Deluge	Torrents activos, velocidad
qBittorrent	Torrents, ratio
Pi-hole	Consultas bloqueadas, % bloqueo
Nextcloud	Notificaciones
pfSense	Tráfico, alertas

Obtener API Keys

Sonarr/Radarr/Lidarr:

Settings → General → Security → API Key

SABnzbd:

Config → General → Security → API Key

NZBGet:

Settings → Security → ControlPassword (usar como API Key)

qBittorrent:

# No requiere API Key, usa usuario/password en enhanced options

Pi-hole:

# API Token desde la UI o:
sudo cat /etc/pihole/setupVars.conf | grep WEBPASSWORD

🏷️ Organizar con Tags

Los tags permiten agrupar aplicaciones por categorías.

Crear Tags

Al añadir/editar app, campo Tags: media, streaming
Separar múltiples tags con comas
Save

Filtrar por Tags

Los tags aparecen como botones en la parte superior
Click en un tag para filtrar aplicaciones

Tags Sugeridos

media         - Jellyfin, Plex, Emby
automation    - Sonarr, Radarr, Lidarr
downloads     - SABnzbd, qBittorrent, Deluge
infrastructure- Portainer, Proxmox, Traefik
monitoring    - Grafana, Prometheus, Uptime Kuma
security      - Pi-hole, pfSense, Vaultwarden
productivity  - Nextcloud, Bookstack, Wiki.js

🎨 Personalización Visual

Cambiar Tema

Modo edición → Settings (icono engranaje arriba)
Theme: Seleccionar tema
- Classic (claro)
- Dark (oscuro)
- Nord
- Gruvbox
- Custom (personalizado)
Save

Cambiar Fondo

Opción 1: URL de Imagen

Settings → Background image
URL: https://example.com/imagen.jpg
Save

Opción 2: Subir Imagen

Settings → Background image
Click en Upload
Seleccionar imagen local
Save

Opción 3: Unsplash Aleatoria

URL de Unsplash con keywords:

https://source.unsplash.com/1920x1080/?nature,landscape

Ajustar Búsqueda

Settings → Search Settings:

Enable search: ✅
Search provider:
- Google
- DuckDuckGo
- Bing
- StartPage
- Custom

Custom search URL:

https://duckduckgo.com/?q=

📐 Organizar Dashboard

Reordenar Aplicaciones

En modo edición:

Drag & drop las tarjetas
Soltar donde quieras
Salir de modo edición → Se guarda automáticamente

Crear Secciones

Usa tags + orden para crear secciones visuales:

Agrupa apps similares con mismo tag
Reordena para que queden juntas

Ejemplo:

[Media]     [Media]    [Media]
[Downloads] [Downloads]
[Admin]     [Admin]

Aplicaciones Destacadas

Marca Pinned ✅ en aplicaciones importantes para mantenerlas arriba.

⚙️ Configuración Avanzada

Multi-usuario (con proxy)

Heimdall no tiene autenticación nativa. Usa:

Con NPM:

Access List con usuario/password (ver NPM)

Con Traefik:

Middleware BasicAuth (ver Traefik)

Dashboard Público vs Privado

Privado (recomendado):

Heimdall detrás de VPN
Access List limitada a red local
Autenticación en proxy

Público (con precaución):

Solo enlaces a servicios públicos
No incluir IPs internas
No incluir admin panels

Configurar Idioma

Heimdall actualmente solo soporta inglés en UI. Los nombres y descripciones de apps pueden ser en español.

🔧 Ajustes del Sistema

Variables de Entorno

Editar en Portainer → Stack Editor o en docker-compose.yml:

environment:
  PUID: 1000        # ID de usuario (tu UID)
  PGID: 1000        # ID de grupo (tu GID)
  TZ: Europe/Madrid # Zona horaria

Obtener tu UID/GID:

id

Reiniciar Heimdall

docker restart heimdall

O desde Portainer: Containers → heimdall → Restart

📱 Acceso Móvil

Heimdall es completamente responsive.

Añadir a Pantalla de Inicio (iOS/Android)

iOS:

Safari → https://heimdall.tudominio.com
Icono compartir → Añadir a pantalla de inicio
Nombrar: Dashboard

Android:

Chrome → https://heimdall.tudominio.com
Menú → Añadir a pantalla de inicio

Ahora funciona como una app.

🚀 Siguiente Paso

Personalización - Temas, fondos, búsqueda avanzada
Backup y Restauración - Protege tu configuración
Actualización - Mantén Heimdall al día

Repositorio: groales/heimdall