Saltar a contenido

Este sitio (MkDocs Material)

https://docs.fadua.ar es un sitio estático generado con Material for MkDocs, construido en Docker y publicado por Coolify con HTTP Basic Auth.

Inventario

Campo Valor
Repo FADUA-S-A/sla-crp-mkdocs
Rama main
Build pack Dockerfile
Puerto interno 80
Dominio https://docs.fadua.ar
Auth Coolify → Application → General → HTTP Basic Authentication
Source GitHub coolify-github-app-fadua-sla

Cómo se construye

flowchart LR
  MD[docs/*.md] --> Build[mkdocs build --strict]
  Build --> Nginx[nginx:alpine puerto 80]
  Nginx --> Traefik
  Traefik --> Auth[Basic Auth]
  Auth --> Browser[docs.fadua.ar]

El Dockerfile instala MkDocs, genera /site y lo copia a nginx. No hay volumen: cada deploy tira el HTML anterior y publica uno nuevo.

--strict corta el build si hay un link roto o un ítem de nav que apunta a un archivo que no existe.

Cómo se dio de alta (resumen de lo que hicimos)

  1. Repo template en GitHub (sla-crp-mkdocs).
  2. GitHub App en FADUA-S-A, camino manual, Installation ID de la org.
  3. Application: Private Repository (GitHub App) → ese repo → rama main.
  4. Build pack Dockerfile, puerto 80 (no Railpack / 3000).
  5. Dominio https://docs.fadua.ar.
  6. Primer deploy: el sitio abría sin pedir clave.
  7. Basic Auth ON + Deploy de nuevo → popup de usuario/contraseña.
  8. Auto Deploy en main.

Cómo editar la documentación

  1. Cambiá archivos en docs/ (y mkdocs.yml si hay página nueva).
  2. Commit + push a main.
  3. Coolify rebuilds. Cuando el deploy está verde, recargá docs.fadua.ar.

En local:

cd sla-crp-mkdocs
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
mkdocs serve

http://127.0.0.1:8000 — sin Basic Auth (eso solo está en producción).

Secretos

No van en el repo:

  • usuario/contraseña del Basic Auth
  • Client secret / webhook secret de la GitHub App
  • el .pem

Sí se documenta dónde se configuran (Coolify, GitHub).

Más contexto de plataforma: Qué es Coolify.