diff --git a/README.md b/README.md index 0f75273..280e365 100644 --- a/README.md +++ b/README.md @@ -56,14 +56,17 @@ docker compose up -d **Stacks** → **Add stack** - **Name**: `heimdall` -- **Build method**: - - **Git Repository**: - - Repository URL: `https://git.ictiberia.com/groales/heimdall` - - Repository reference: `refs/heads/main` - - Compose path: `docker-compose.yml` - - O **Web editor**: Pegar contenido de `docker-compose.yml` +- **Build method**: **Git Repository** + - **Repository URL**: `https://git.ictiberia.com/groales/heimdall` + - **Repository reference**: `refs/heads/main` + - **Compose path**: `docker-compose.yml` + - **Additional paths** (opcional): + - Para Traefik: `docker-compose.override.traefik.yml.example` + - Para NPM: `docker-compose.override.npm.yml.example` - **Deploy the stack** +**Nota**: Si usas **Additional paths**, no necesitas copiar el archivo a `.override.yml`. Portainer fusiona automáticamente los archivos especificados. + #### 2. Verificar despliegue **Stacks** → `heimdall` → Ver logs del contenedor @@ -108,13 +111,45 @@ Para habilitar: - Proporcionar **API Key** del servicio - Configurar **Enhanced options** -## Integración con NGINX Proxy Manager +## Integración con Proxy Inverso -### 1. Conectar a red proxy +Este repositorio incluye archivos override para facilitar la integración: +- `docker-compose.override.traefik.yml.example` - Para Traefik +- `docker-compose.override.npm.yml.example` - Para NGINX Proxy Manager + +### Con Traefik + +**Desde Portainer (Git)**: +- **Additional paths**: `docker-compose.override.traefik.yml.example` +- Editar dominio en el archivo antes de desplegar, o después desde Stack Editor + +**Desde CLI**: +```bash +cp docker-compose.override.traefik.yml.example docker-compose.override.yml +# Editar dominio en docker-compose.override.yml +docker compose up -d +``` + +Accede a: `https://heimdall.tudominio.com` + +### Con NGINX Proxy Manager + +#### 1. Conectar a red proxy La red `proxy` se crea automáticamente al desplegar el stack (compartida con NPM). -### 2. Configurar Proxy Host en NPM +#### 2. Desplegar (Opcional con override) + +**Desde Portainer**: Usar `docker-compose.override.npm.yml.example` en **Additional paths** si necesitas personalizar puertos o PUID/PGID. + +**Desde CLI**: +```bash +cp docker-compose.override.npm.yml.example docker-compose.override.yml +# Editar si necesitas personalizar +docker compose up -d +``` + +#### 3. Configurar Proxy Host en NPM Accede a NPM (puerto 81) y crea un Proxy Host: diff --git a/docker-compose.override.npm.yml.example b/docker-compose.override.npm.yml.example new file mode 100644 index 0000000..93fec4d --- /dev/null +++ b/docker-compose.override.npm.yml.example @@ -0,0 +1,29 @@ +# docker-compose.override.npm.yml.example +# +# Este archivo muestra cómo preparar Heimdall para integración con NPM del repositorio groales/npm. +# Para usarlo: +# Desde Portainer (Git Repository): +# - Repository URL: https://git.ictiberia.com/groales/heimdall +# - Compose path: docker-compose.yml +# - Additional paths: docker-compose.override.npm.yml.example +# +# Desde CLI: +# 1. Copia este archivo a docker-compose.override.yml +# +# Docker Compose automáticamente fusiona docker-compose.yml + docker-compose.override.yml +# +# IMPORTANTE: La configuración del proxy host se hace desde la UI de NPM, no mediante labels. +# Este override solo asegura que Heimdall está en la red compartida (ya incluido en docker-compose.yml base). +# Puedes usar este archivo para personalizar puertos o variables de entorno. + +services: + heimdall: + # Descomenta y personaliza si necesitas cambiar puertos + # ports: + # - "9080:80" + # - "9443:443" + + # Descomenta y personaliza PUID/PGID según tu sistema + # environment: + # PUID: 1001 + # PGID: 1001 diff --git a/docker-compose.override.traefik.yml.example b/docker-compose.override.traefik.yml.example new file mode 100644 index 0000000..2710708 --- /dev/null +++ b/docker-compose.override.traefik.yml.example @@ -0,0 +1,32 @@ +# docker-compose.override.traefik.yml.example +# +# Este archivo muestra cómo integrar Heimdall con Traefik del repositorio groales/traefik. +# Para usarlo: +# Desde Portainer (Git Repository): +# - Repository URL: https://git.ictiberia.com/groales/heimdall +# - Compose path: docker-compose.yml +# - Additional paths: docker-compose.override.traefik.yml.example +# +# Desde CLI: +# 1. Copia este archivo a docker-compose.override.yml +# 2. Ajusta el dominio (heimdall.tudominio.com) +# +# Docker Compose automáticamente fusiona docker-compose.yml + docker-compose.override.yml + +services: + heimdall: + labels: + # Habilitar Traefik + - "traefik.enable=true" + + # Router HTTPS + - "traefik.http.routers.heimdall.rule=Host(`heimdall.tudominio.com`)" + - "traefik.http.routers.heimdall.entrypoints=websecure" + - "traefik.http.routers.heimdall.tls=true" + - "traefik.http.routers.heimdall.tls.certresolver=letsencrypt" + + # Service backend + - "traefik.http.services.heimdall.loadbalancer.server.port=80" + + # Middlewares de seguridad (opcional) + - "traefik.http.routers.heimdall.middlewares=security-headers@file"