docs: refresh service inventory and Compose usage

This commit is contained in:
Eduardo David Paredes Vara
2026-10-18 22:03:04 +00:00
parent 634028d508
commit 07ec97ad45
+36 -3
View File
@@ -12,6 +12,8 @@ Portainer ya no es el gestor de despliegue de este repo. Los despliegues se hace
- [Servicios](#servicios) - [Servicios](#servicios)
- [Configuracion](#configuracion) - [Configuracion](#configuracion)
- [Uso](#uso) - [Uso](#uso)
- [Troubleshooting](#troubleshooting)
- [Retirar un stack](#retirar-un-stack)
- [Anadir una nueva app](NUEVA-APP.md) - [Anadir una nueva app](NUEVA-APP.md)
## Arquitectura ## Arquitectura
@@ -23,6 +25,10 @@ La infraestructura base se levanta en este orden:
3. `crowdsec/`: proteccion colaborativa y bouncer para Traefik. 3. `crowdsec/`: proteccion colaborativa y bouncer para Traefik.
4. Resto de servicios: cada uno desde su propia carpeta. 4. Resto de servicios: cada uno desde su propia carpeta.
Sablier permite arrancar y detener bajo demanda los servicios que tengan su
middleware configurado. Un contenedor detenido no implica por sí solo una avería;
consulta su configuración y sus logs antes de intervenir.
Los servicios publicados comparten la red Docker externa `proxy`, que Traefik usa para alcanzarlos. Los servicios publicados comparten la red Docker externa `proxy`, que Traefik usa para alcanzarlos.
Configura DNS antes de desplegar servicios expuestos. Los certificados de Let's Encrypt dependen de que los dominios resuelvan correctamente. Configura DNS antes de desplegar servicios expuestos. Los certificados de Let's Encrypt dependen de que los dominios resuelvan correctamente.
@@ -30,7 +36,7 @@ Configura DNS antes de desplegar servicios expuestos. Los certificados de Let's
## Prerequisitos ## Prerequisitos
- Docker Engine - Docker Engine
- Docker Compose v2 - Docker Compose con el comando `docker compose`
- Red Docker externa `proxy` - Red Docker externa `proxy`
- Dominios apuntando al servidor o al Cloudflare Tunnel correspondiente - Dominios apuntando al servidor o al Cloudflare Tunnel correspondiente
- Puertos 80/443 disponibles para Traefik si aplica - Puertos 80/443 disponibles para Traefik si aplica
@@ -49,6 +55,7 @@ Cada servicio se despliega desde su carpeta con su `.env` local:
```bash ```bash
cd Traefik cd Traefik
docker compose --env-file .env config --quiet
docker compose --env-file .env up -d docker compose --env-file .env up -d
``` ```
@@ -74,10 +81,17 @@ cd <servicio>
docker compose --env-file .env down docker compose --env-file .env down
``` ```
Usa `docker compose --env-file .env -f <ruta>/docker-compose.yml up -d` si prefieres ejecutar desde la raiz del repo. Desde la raiz del repo, indica tanto el Compose como el `.env` del servicio:
```bash
docker compose --env-file <servicio>/.env -f <servicio>/docker-compose.yml up -d
```
## Servicios ## Servicios
El inventario recoge las definiciones disponibles en el repositorio; no implica
que todos los servicios estén desplegados o activos en el host.
| Servicio | Descripcion | Carpeta | Documentacion | | Servicio | Descripcion | Carpeta | Documentacion |
|---|---|---|---| |---|---|---|---|
| Traefik | Reverse proxy con TLS automatico | `Traefik/` | [README](Traefik/README.md) | | Traefik | Reverse proxy con TLS automatico | `Traefik/` | [README](Traefik/README.md) |
@@ -92,7 +106,22 @@ Usa `docker compose --env-file .env -f <ruta>/docker-compose.yml up -d` si prefi
| Wireguard | VPN | `wireguard/` | [README](wireguard/README.md) | | Wireguard | VPN | `wireguard/` | [README](wireguard/README.md) |
| Open WebUI | UI para modelos locales/remotos | `openwebui/` | [README](openwebui/README.md) | | Open WebUI | UI para modelos locales/remotos | `openwebui/` | [README](openwebui/README.md) |
| OpenCode | Entorno OpenCode servido por Traefik | `opencode/` | [README](opencode/README.md) | | OpenCode | Entorno OpenCode servido por Traefik | `opencode/` | [README](opencode/README.md) |
| Cloudflare | Gestion DNS y definicion opcional de Cloudflare Tunnel | `cloudflared/` | [README](cloudflared/README.md) |
| FreshRSS | Lector y agregador de feeds RSS | `freshrss/` | [README](freshrss/README.md) |
| Guacamole | Escritorio remoto desde el navegador | `guacamole/` | [README](guacamole/README.md) |
| Karakeep | Archivo y busqueda de enlaces | `karakeep/` | [README](karakeep/README.md) |
| LiteLLM | Pasarela central de APIs de modelos | `litellm/` | [README](litellm/README.md) |
| Media Server | Streaming y gestion de contenido multimedia | `media-server/` | [README](media-server/README.md) |
| Nextcloud | Archivos y colaboracion con OnlyOffice | `nextcloud/` | [README](nextcloud/README.md) |
| OpenGist | Fragmentos de codigo versionados con OIDC | `opengist/` | [README](opengist/README.md) |
| Paperless-ngx | Archivo documental con OCR y clasificacion IA | `paperless/` | [README](paperless/README.md) |
| PrivateBin | Pastebin con cifrado en el navegador | `privatebin/` | [README](privatebin/README.md) |
| Sablier | Arranque y parada de servicios bajo demanda | `sablier/` | [README](sablier/README.md) |
| Kopia | Backups | `backups/kopia/` | [README](backups/kopia/README.md) | | Kopia | Backups | `backups/kopia/` | [README](backups/kopia/README.md) |
| n8n Observability | Scripts de monitorizacion del host invocados desde n8n | `n8n-observability/` | [README](n8n-observability/README.md) |
Kopia y n8n Observability tienen sus propios procedimientos documentados; no
se despliegan siguiendo el flujo Compose de las carpetas de servicio.
## Configuracion ## Configuracion
@@ -120,9 +149,10 @@ Para crear una app nueva, sigue [NUEVA-APP.md](NUEVA-APP.md).
## Uso ## Uso
Ver contenedores: Ver proyectos Compose activos y todos los contenedores del host:
```bash ```bash
docker compose ls
docker ps -a docker ps -a
``` ```
@@ -140,6 +170,9 @@ cd <servicio>
docker compose --env-file .env config docker compose --env-file .env config
``` ```
Para validar sin imprimir la configuración expandida y sus posibles secretos,
usa `docker compose --env-file .env config --quiet`.
## Troubleshooting ## Troubleshooting
Si Traefik no enruta: Si Traefik no enruta: