From 03848f76fd5b532159b4d93a267f5ffe05034856 Mon Sep 17 00:00:00 2001 From: "Mauro Rosero P." Date: Sun, 6 Apr 2025 11:16:58 -0500 Subject: [PATCH] =?UTF-8?q?[DOCS]=20Actualizado=20README=20con=20enlaces?= =?UTF-8?q?=20a=20documentaci=C3=B3n=20de=20SOPS?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Añadidos enlaces a la documentación de SOPS y SOPS Rules - Mejorada la visibilidad de la documentación disponible - Agregada nota con enlaces a la documentación relevante - Actualizada referencia al script sops_rules.sh con enlace a documentación 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7e2ffc5..8b324ee 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ bin/sops_rules.sh bin/update.sh ``` -> **IMPORTANTE**: La configuración de SOPS con `bin/sops_rules.sh` es un paso obligatorio antes de poder utilizar la plataforma. Este script configura la encriptación GPG para los secretos, permitiendo el funcionamiento seguro de todas las funcionalidades que requieren encriptación. +> **IMPORTANTE**: La configuración del arcivo de reglas de sops .sops.yaml es un paso obligatorio antes de poder utilizar la plataforma. bin/sops_rules.sh crea el archivo base de configguración sops para el proyecto. Las claves GPG del desarrollador principal debe existir en el repositorio de claves. ### Estructura de Directorios @@ -144,8 +144,8 @@ MRDevs Tools integra herramientas modernas de Charm para mejorar la experiencia | Comando | Descripción | |---------|-------------| -| `bin/sops_rules.sh` | Configura SOPS con clave GPG para encriptación segura de secretos | -| `bin/qr_secret.sh` | Extrae secretos de imágenes QR y los guarda encriptados con SOPS | +| `bin/sops_rules.sh` | Configura SOPS con clave GPG para encriptación segura de secretos ([documentación](docs/sops_rules.md)) | +| `bin/qr_secret.sh` | Extrae secretos de imágenes QR y los guarda encriptados con [SOPS](docs/sops.md) | | `bin/vpn_install.sh` | Instala el cliente Pritunl VPN | | `bin/vpn_install.sh --update` | Actualiza el cliente VPN a la última versión | | `bin/vpn_users.sh` | Gestiona usuarios de la VPN | @@ -168,6 +168,8 @@ MRDevs Tools integra herramientas modernas de Charm para mejorar la experiencia ## 📚 Guía de Usuario +> **NOTA**: Consulta nuestra documentación detallada en: [SOPS](docs/sops.md), [SOPS Rules](docs/sops_rules.md) y [Gum Forms](docs/forms-gum.md). + ### Herramientas de CLI Modernas MRDevs Tools incluye soporte completo para herramientas modernas de CLI de [Charm](https://charm.sh/): @@ -605,8 +607,8 @@ El script analizará el código fuente, contará las líneas efectivas, y calcul MRDevs Tools está diseñado con la seguridad y privacidad en mente: -- **Almacenamiento seguro**: Todos los tokens y credenciales se almacenan encriptados usando SOPS con PGP -- **Configuración GPG obligatoria**: El script `sops_rules.sh` configura la clave maestra para encriptación de secretos +- **Almacenamiento seguro**: Todos los tokens y credenciales se almacenan encriptados usando [SOPS](docs/sops.md) con PGP +- **Configuración GPG obligatoria**: El script [`sops_rules.sh`](docs/sops_rules.md) configura la clave maestra para encriptación de secretos - **Directorios ocultos**: La configuración sensible se almacena en directorios ocultos (con prefijo `.`) - **Sin telemetría**: Las herramientas no recopilan ni envían datos de uso - **Podman como predeterminado**: Se usa Podman (sin privilegios) para mayor seguridad en contenedores @@ -724,7 +726,7 @@ El texto completo de la licencia está disponible en el archivo [LICENSE.md](LIC Para dudas o problemas, contacte con: - Email: mauro@rosero.one -- Web: https://rosero.one +- Web: https://mauro.rosero.one ---