Autoalojamiento

Hold My Docs almacena las páginas de la wiki como commits de Git para facilitar la recuperación

Una nueva wiki autoalojada llamada Hold My Docs guarda cada edición de página como un commit de Git, manteniendo la documentación accesible incluso si la aplicación falla.

Ilustración de documentos de papel convirtiéndose en ramas de git dentro de un rack de servidores
Ilustración creada para este artículo

Traducido automáticamente del original en inglés.

Hold My Docs es una nueva herramienta de código abierto diseñada para resolver el problema común de la documentación del servidor perdida o inaccesible. Lanzada a finales de octubre de 2026, esta wiki autoalojada almacena todo el contenido como archivos Markdown estándar dentro de un repositorio Git, en lugar de ocultarlos en una base de datos propietaria. Este enfoque garantiza que las notas técnicas sigan siendo legibles y controladas por versiones, incluso si la interfaz web deja de estar disponible.

Qué ha ocurrido

La innovación central de Hold My Docs reside en su mecanismo de almacenamiento. En lugar de depender de un esquema de base de datos complejo para gestionar el contenido, la aplicación escribe cada guardado de página directamente en un repositorio Git. Esto significa que cada edición crea un nuevo commit, proporcionando un historial completo de cambios sin necesidad de herramientas adicionales de copia de seguridad. Los usuarios pueden navegar por este historial a través de la interfaz web o acceder a los archivos originales directamente desde el sistema de archivos del servidor.

Este diseño aborda un punto de dolor frecuente para los entusiastas de los homelabs y los pequeños equipos de TI: la degradación de la documentación. Cuando los servidores cambian, las configuraciones se modifican y las notas antiguas quedan obsoletas. Con Hold My Docs, los administradores pueden revertir a versiones anteriores de una página si una nueva configuración falla o si necesitan recordar por qué se eligió un ajuste específico meses atrás. La aplicación también admite la sincronización con repositorios Git remotos, permitiendo a los equipos mantener automáticamente una copia externa de su base de conocimiento.

Más allá del simple almacenamiento de texto, la herramienta ofrece un editor Markdown basado en navegador con vistas previas en vivo. Admite enlaces internos y backlinks, ayudando a los usuarios a conectar temas relacionados. Una característica destacada es el soporte para diagramas Mermaid, lo que permite a los ingenieros dibujar topologías de red o arquitecturas de servicios directamente dentro de sus notas. Esto elimina la necesidad de software de diagramación separado y mantiene la documentación visual junto con las instrucciones textuales.

Detalles clave

  • Backend de almacenamiento: Todas las páginas de la wiki se almacenan como archivos Markdown simples en un repositorio Git local.
  • Control de versiones: Cada acción de guardado genera un commit de Git, habilitando el seguimiento completo del historial y capacidades de reversión.
  • Opciones de despliegue: La aplicación está escrita en Go y puede ejecutarse como un binario independiente o mediante una configuración oficial de Docker Compose.
  • Autenticación: Admite cuentas de usuario locales y OpenID Connect (OIDC) para la integración con proveedores de identidad existentes.
  • Capacidades de búsqueda: Incluye búsqueda de texto completo para las páginas de la wiki, con integración opcional de Apache Tika para indexar documentos PDF y de Office.
  • Funciones de exportación: Los usuarios pueden exportar espacios de nombres completos como sitios web estáticos para compartirlos públicamente sin exponer la aplicación de la wiki.

Contexto

Para entender el valor de Hold My Docs, ayuda reconocer las limitaciones del software de wiki tradicional. Muchas wikis autoalojadas almacenan el contenido en bases de datos como SQLite o PostgreSQL. Aunque son eficientes para consultas, esto hace que los datos sean difíciles de acceder fuera de la aplicación. Si el software de la wiki se rompe o deja de tener soporte, extraer el contenido puede ser complicado. Al usar Git, Hold My Docs aprovecha una tecnología en la que la mayoría de los desarrolladores y administradores de sistemas ya confían y comprenden.

Git es un sistema de control de versiones distribuido ampliamente utilizado para el desarrollo de software. Rastrea los cambios en los archivos a lo largo del tiempo, permitiendo a los usuarios ver quién cambió qué y cuándo. Al tratar la documentación como código, Hold My Docs asegura que los datos permanezcan portables. Markdown es un lenguaje de marcado ligero que es fácil de leer en formato de texto plano. La combinación de estas dos tecnologías crea un sistema de documentación resiliente y preparado para el futuro, reduciendo el riesgo de bloqueo por proveedor (vendor lock-in).

Por qué importa

Para los equipos que ejecutan su propio software, la accesibilidad durante las interrupciones es crítica. Si tu servidor de documentación se cae, a menudo necesitas esa documentación para arreglar el servidor. Hold My Docs mitiga este dilema (catch-22) manteniendo los archivos subyacentes en un formato estándar. Incluso si la interfaz web es inalcanzable, un administrador puede conectarse por SSH al servidor, navegar hasta el repositorio Git y leer los archivos Markdown directamente. Esta resiliencia es una ventaja significativa sobre las soluciones basadas en bases de datos.

Además, la separación de responsabilidades entre información privada y pública se simplifica mediante espacios de nombres. Los administradores pueden mantener credenciales sensibles del servidor y mapas de red interna en un espacio de nombres privado, mientras exportan notas generales del proyecto o domésticas no sensibles como un sitio estático. Esta flexibilidad permite a las organizaciones compartir conocimiento externamente sin comprometer la seguridad ni mantener sistemas separados.

La integración opcional del servidor MCP (Model Context Protocol) también apunta hacia flujos de trabajo futuros donde los asistentes de IA pueden consultar la documentación de forma segura. Sin embargo, esto requiere una gestión cuidadosa de permisos para evitar que las herramientas de IA accedan a detalles sensibles de la infraestructura. El diseño de la herramienta fomenta un enfoque disciplinado hacia la documentación, facilitando el mantenimiento de registros precisos con el tiempo.

Qué puedes hacer

  • Prueba el despliegue con Docker: Usa el archivo oficial de Docker Compose para lanzar una instancia local y evaluar la interfaz sin comprometerte con una configuración a largo plazo.
  • Configura el almacenamiento local con cuidado: Asegúrate de que el directorio de datos de la aplicación resida en almacenamiento local en lugar de NFS para evitar problemas de rendimiento, aunque el repositorio Git puede sincronizarse con almacenamiento de red.
  • Configura OIDC temprano: Integra con tu proveedor de identidad existente durante la configuración inicial para agilizar la gestión de usuarios y evitar administrar cuentas locales separadas.
  • Habilita los diagramas Mermaid: Comienza a documentar estructuras de red usando sintaxis Mermaid dentro de tus páginas para mantener las ayudas visuales sincronizadas con el texto.
  • Programa copias de seguridad regulares: Aunque Git proporciona historial, mantén copias de seguridad externas del repositorio para protegerte contra fallos físicos del hardware.
  • Revisa los permisos antes de habilitar MCP: Si planeas usar la integración de IA, limita estrictamente el acceso a espacios de nombres no sensibles para proteger los datos privados de la infraestructura.

Más noticias

Todas las noticias