diff --git a/bookstack/README.md b/bookstack/README.md new file mode 100644 index 0000000..d4642f4 --- /dev/null +++ b/bookstack/README.md @@ -0,0 +1,26 @@ +# BookStack + +Base de conocimiento y documentación desplegada con MariaDB, acceso por Traefik y envío de correo mediante `mail-relay`. + +## Requisitos + +- Docker Compose +- Redes externas `proxy` y `mail_internal` +- Un archivo `.env` local con las imágenes, dominio, rutas, credenciales de base de datos y `APP_KEY` + +## Despliegue + +```bash +cd bookstack +docker compose --env-file .env config +docker compose --env-file .env up -d +``` + +Los datos de BookStack y MariaDB se conservan en las rutas indicadas por `BOOKSTACK_DATA_PATH` y `BOOKSTACK_DB_PATH`. + +## Operación + +```bash +docker compose --env-file .env ps +docker compose --env-file .env logs -f bookstack +``` diff --git a/karakeep/README.md b/karakeep/README.md new file mode 100644 index 0000000..b68b21b --- /dev/null +++ b/karakeep/README.md @@ -0,0 +1,27 @@ +# Karakeep + +Servicio para guardar, buscar y enriquecer enlaces. Incluye Karakeep, un navegador Chromium para capturas y Meilisearch para indexación. + +## Requisitos + +- Docker Compose +- Red externa `proxy` +- Un archivo `.env` local con dominio, secretos de NextAuth y Meilisearch, y la configuración opcional de inferencia +- Directorios persistentes bajo `/opt/karakeep` + +## Despliegue + +```bash +cd karakeep +docker compose --env-file .env config +docker compose --env-file .env up -d +``` + +## Operación + +```bash +docker compose --env-file .env ps +docker compose --env-file .env logs -f karakeep +``` + +El registro de usuarios se controla con `DISABLE_SIGNUPS` en `.env`. diff --git a/litellm/README.md b/litellm/README.md new file mode 100644 index 0000000..0e28f7a --- /dev/null +++ b/litellm/README.md @@ -0,0 +1,28 @@ +# LiteLLM + +Proxy unificado para proveedores de modelos LLM, con configuración en `config.yaml`, proveedor local en `codex_provider.py` y PostgreSQL para persistencia. + +## Requisitos + +- Docker Compose +- Red externa `proxy` +- Un archivo `.env` local con las claves de proveedores, claves maestras de LiteLLM y credenciales PostgreSQL +- El archivo de autenticación de Codex montado en la ruta definida por el Compose +- Enrutamiento dinámico de Traefik configurado fuera de esta aplicación + +## Despliegue + +```bash +cd litellm +docker compose --env-file .env config +docker compose --env-file .env up -d +``` + +## Operación + +```bash +docker compose --env-file .env ps +docker compose --env-file .env logs -f litellm +``` + +La API se autentica con `LITELLM_MASTER_KEY`; no publiques esa clave ni el `.env`. diff --git a/memos/README.md b/memos/README.md new file mode 100644 index 0000000..d56514f --- /dev/null +++ b/memos/README.md @@ -0,0 +1,28 @@ +# Memos + +Aplicación de notas ligeras respaldada por PostgreSQL. El contenedor `memos-proxy` actúa como punto de entrada hacia Memos. + +## Requisitos + +- Docker Compose +- Red externa `proxy` +- Un archivo `.env` local con dominio y credenciales PostgreSQL +- El archivo `proxy/server.js` +- Directorios persistentes `/opt/memos/postgres` y `/opt/memos/data` + +## Despliegue + +```bash +cd memos +docker compose --env-file .env config +docker compose --env-file .env up -d +``` + +## Operación + +```bash +docker compose --env-file .env ps +docker compose --env-file .env logs -f memos memos-proxy +``` + +El Compose no habilita Traefik directamente; el enrutamiento debe existir en la configuración externa correspondiente. diff --git a/nextcloud/README.md b/nextcloud/README.md new file mode 100644 index 0000000..ba08fc9 --- /dev/null +++ b/nextcloud/README.md @@ -0,0 +1,29 @@ +# Nextcloud + +Plataforma de archivos y colaboración con MariaDB, Redis, tareas cron y OnlyOffice Document Server. + +## Requisitos + +- Docker Compose +- Redes externas `proxy` y `mail_internal` +- Un archivo `.env` local con dominios, credenciales, secretos de OnlyOffice, proxy de confianza y correo SMTP +- Almacenamiento persistente bajo `/opt/nextcloud` y `/opt/onlyoffice` + +## Despliegue + +```bash +cd nextcloud +docker compose --env-file .env config +docker compose --env-file .env up -d +``` + +Traefik expone Nextcloud y OnlyOffice en los dominios configurados por `NC_DOMAIN` y `OO_DOMAIN`. + +## Operación + +```bash +docker compose --env-file .env ps +docker compose --env-file .env logs -f nextcloud nextcloud-cron onlyoffice-documentserver +``` + +El montaje `/opt/paperless/media` es opcional y se presenta a Nextcloud en modo de sólo lectura. diff --git a/onetimesecret/README.md b/onetimesecret/README.md new file mode 100644 index 0000000..913f09e --- /dev/null +++ b/onetimesecret/README.md @@ -0,0 +1,27 @@ +# OneTimeSecret + +Servicio para compartir secretos de un solo uso, con Redis para persistencia temporal y autenticación OIDC mediante Authentik. + +## Requisitos + +- Docker Compose +- Red externa `proxy` +- Un archivo `.env` local con dominio, secreto principal, configuración OIDC, imágenes y rutas persistentes +- Cliente OIDC con la URL de retorno `https:///auth/sso/oidc/callback` + +## Despliegue + +```bash +cd onetimesecret +docker compose --env-file .env config +docker compose --env-file .env up -d +``` + +## Operación + +```bash +docker compose --env-file .env ps +docker compose --env-file .env logs -f ots ots-redis +``` + +El alta local está deshabilitada y el acceso se fuerza mediante SSO. diff --git a/opengist/README.md b/opengist/README.md new file mode 100644 index 0000000..2547cc6 --- /dev/null +++ b/opengist/README.md @@ -0,0 +1,26 @@ +# OpenGist + +Repositorio privado de gists y fragmentos de código, publicado mediante Traefik y autenticado por OIDC. + +## Requisitos + +- Docker Compose +- Red externa `proxy` +- Un archivo `.env` local con imagen, dominio, ruta de datos y credenciales OIDC + +## Despliegue + +```bash +cd opengist +docker compose --env-file .env config +docker compose --env-file .env up -d +``` + +Los datos se conservan en la ruta configurada por `OPENGIST_DATA_PATH`. + +## Operación + +```bash +docker compose --env-file .env ps +docker compose --env-file .env logs -f opengist +``` diff --git a/paperless/README.md b/paperless/README.md new file mode 100644 index 0000000..fbc3cf0 --- /dev/null +++ b/paperless/README.md @@ -0,0 +1,28 @@ +# Paperless-ngx + +Gestión documental con PostgreSQL, Redis, Tika y Gotenberg. El despliegue también incluye Paperless AI y una sincronización unidireccional desde una carpeta de Nextcloud. + +## Requisitos + +- Docker Compose +- Redes externas `proxy` y `mail_internal` +- Un archivo `.env` local con dominios, credenciales, correo, proxy de confianza y acceso WebDAV a Nextcloud +- Directorios persistentes bajo `/opt/paperless`, `/opt/paperless-ai` y `/opt/rclone` +- Script `/opt/paperless/rclone-sync.sh` + +## Despliegue + +```bash +cd paperless +docker compose --env-file .env config +docker compose --env-file .env up -d +``` + +## Operación + +```bash +docker compose --env-file .env ps +docker compose --env-file .env logs -f paperless paperless-ai paperless-inbox-sync +``` + +La sincronización copia documentos desde Nextcloud a `/opt/paperless/consume`; revisa sus logs antes de cambiar rutas o credenciales WebDAV. diff --git a/privatebin/README.md b/privatebin/README.md new file mode 100644 index 0000000..872f8d4 --- /dev/null +++ b/privatebin/README.md @@ -0,0 +1,27 @@ +# PrivateBin + +Pastebin con cifrado de extremo a extremo en el navegador, ejecutado en modo de sólo lectura y publicado mediante Traefik. + +## Requisitos + +- Docker Compose +- Red externa `proxy` +- Un archivo `.env` local con imagen, dominio, red de Traefik y ruta de datos +- El archivo local `nginx-site.conf` + +## Despliegue + +```bash +cd privatebin +docker compose --env-file .env config +docker compose --env-file .env up -d +``` + +Los pastes cifrados se conservan en la ruta configurada por `PRIVATEBIN_DATA_PATH`. + +## Operación + +```bash +docker compose --env-file .env ps +docker compose --env-file .env logs -f privatebin +``` diff --git a/sablier/README.md b/sablier/README.md new file mode 100644 index 0000000..dd360a6 --- /dev/null +++ b/sablier/README.md @@ -0,0 +1,27 @@ +# Sablier + +Proveedor de arranque bajo demanda para servicios Docker. Se conecta al socket de Docker y a la red externa `proxy`. + +## Requisitos + +- Docker Compose +- Red externa `proxy` +- Un archivo `.env` local con `SABLIER_VERSION` +- Acceso de sólo lectura a `/var/run/docker.sock` + +## Despliegue + +```bash +cd sablier +docker compose --env-file .env config +docker compose --env-file .env up -d +``` + +## Operación + +```bash +docker compose --env-file .env ps +docker compose --env-file .env logs -f sablier +``` + +El acceso al socket permite controlar otros contenedores; limita quién puede modificar este Compose y su `.env`. diff --git a/vikunja/README.md b/vikunja/README.md new file mode 100644 index 0000000..c337ac8 --- /dev/null +++ b/vikunja/README.md @@ -0,0 +1,27 @@ +# Vikunja + +Gestor de tareas y proyectos con PostgreSQL, soporte CalDAV y envío de recordatorios por correo. + +## Requisitos + +- Docker Compose +- Redes externas `proxy` y `mail_internal` +- Un archivo `.env` local con dominio, secreto JWT, credenciales PostgreSQL y configuración SMTP +- Directorios persistentes `/opt/vikunja/postgres` y `/opt/vikunja/files` + +## Despliegue + +```bash +cd vikunja +docker compose --env-file .env config +docker compose --env-file .env up -d +``` + +## Operación + +```bash +docker compose --env-file .env ps +docker compose --env-file .env logs -f vikunja vikunja-db +``` + +El registro público está deshabilitado. Traefik publica el servicio usando el dominio configurado en `VIKUNJA_DOMAIN`.