Saltar a contenido

🧰 Servicios auxiliares de CORDIA

Además de la API, el panel de revisión y el backend técnico, CORDIA se apoya en una serie de servicios auxiliares que permiten tareas de monitorización, documentación, administración o visualización avanzada de datos.


🧭 Lista de servicios y funciones

Servicio Función principal Acceso local
Grafana Visualización de métricas, paneles estadísticos grafana.cordia.local
Uptime Kuma Monitorización del estado de los servicios status.cordia.local
Adminer Administración manual de la base de datos adminer.cordia.local
SchemaSpy Visualización gráfica del esquema relacional schema.cordia.local
Nginx Proxy Manager (NPM) Gestión de subdominios y certificados locales npm.cordia.local:81
Swagger UI Visualización de la documentación OpenAPI (Scribe) swagger.cordia.local
Scribe (HTML) Documentación extendida de endpoints Laravel apidocs.cordia.local
MkDocs Documentación técnica y general (Markdown) docs.cordia.local
DevDocs Documentación interna de desarrollo devdocs.cordia.local

📁 Estructura de carpetas

Estos servicios suelen generar contenido en las siguientes carpetas:

docker-data/
├── grafana/                # Datos persistentes de Grafana
├── npm/                    # Configuración de Nginx Proxy Manager
├── uptime-kuma/            # Datos persistentes de Uptime Kuma
├── mysql/                  # Volumen de MySQL (opcional según backups)
└── letsencrypt/            # Certificados SSL gestionados por NPM

public/
├── apidocs.cordia/         # Documentación de Scribe (API HTML, OpenAPI, Postman)
├── devdocs.cordia/         # Documentación técnica interna (MkDocs)
├── docs/                   # Documentación estática adicional (legacy)
├── docs.api/               # Documentación API pública (MkDocs)
├── docs.cordia/            # Documentación general (MkDocs)
├── docs.schema/            # Documentación de esquema (MkDocs)
├── reports.cordia/         # Reportes HTML/JSON de importadores/tests
├── schema.cordia/          # Salida de SchemaSpy
├── swagger.cordia/         # Swagger UI (OpenAPI estático)
└── tests.cordia/           # Resultados de tests (HTML/XML)

⚙️ Cómo levantarlos manualmente

Todos los servicios auxiliares pueden levantarse mediante:

./run-service.sh dev <servicio>

Ejemplo:

./run-service.sh dev grafana
./run-service.sh dev uptime

🔐 Seguridad y acceso

  • Algunos servicios como Swagger, DevDocs, Docs y Scribe están protegidos mediante .htpasswd y el proxy interno (cordia-proxy).
  • NPM permite establecer redirecciones seguras y certificados SSL en producción.

Para más detalles sobre dominios, consulta urls.md. Para gestión de contenedores, consulta dockers.md.