From 650c6101377fa7844a018b164a584a4c51af3c2e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kevin=20Mu=C3=B1oz?= Date: Tue, 16 May 2023 16:04:33 -0500 Subject: [PATCH] Update README.md --- README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) diff --git a/README.md b/README.md index 7494bab..ccd505d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,60 @@ # Wazuhdeb +# Documentación de la Herramienta de wazuhdebian +¡Bienvenido/a a la documentación de nuestra herramienta de automatización para instalacion de agentes wazuh en sistemas basados en debian! Aquí encontrarás todas las instrucciones necesarias para comenzar a utilizarla de manera efectiva. +## Descripción de la Herramienta +La herramienta de automatización wazuhdebian es una utilidad que simplifica y automatiza la tarea de instalacion y configuracion de los agentes wazuh en sistemas basados en debian en el entorno de línea de comandos. Está diseñada para ser fácil de usar, lo que la hace adecuada para una rapida instalacion y configuracion de los agentes. + +## Requisitos Previos +Antes de comenzar a utilizar la herramienta, asegúrate de cumplir con los siguientes requisitos: +- Sistema operativo Ubuntu Linux o Debian +- Bash instalado en tu sistema. +- Permisos de ejecución para el archivo de script de la herramienta. + +## Instalación +1. Clona el repositorio de la herramienta desde GitLab: +```bash +git clone https://condorcs.net/kmunoz/wazuhdeb.git +``` + +2. Accede al directorio del repositorio: +```bash +cd wazuhdeb +``` + +3. Valida la integridad del script con la firma adjunta: +```bash +gpg --verify wazuhdebian.sh.asc.sig wazuhdebian.sh +``` + +4. Otorga permisos de ejecución al archivo de script: +```bash +chmod +x wazuhdebian.sh +``` + +## Uso + +1. Abre una terminal en tu sistema. +2. Navega hasta el directorio donde se encuentra el archivo de script de la herramienta. +3. Ejecuta el script de la herramienta: +```bash +sudo ./wazuhdebian.sh +``` +4. Sigue las instrucciones proporcionadas por la herramienta en la terminal para interactuar con ella. + +## Contribución + +Si encuentras algún problema, tienes alguna idea de mejora o quieres contribuir al proyecto, ¡te animamos a hacerlo! Sigue los pasos a continuación: + +1. Crea un _fork_ del repositorio. +2. Realiza los cambios en tu _fork_. +3. Envía un _merge request_ con tus cambios para su revisión. +4. Nuestro equipo revisará tu solicitud y la incorporará en el proyecto principal si se considera apropiada. + +## Problemas Frecuentes + +Aquí se enumeran algunos problemas comunes que podrías encontrar y sus soluciones correspondientes: + +- **Error de permisos**: Asegúrate de haber otorgado los permisos de ejecución al archivo de script de la herramienta utilizando el comando `chmod +x tool.sh`. +- **Comando no encontrado**: Verifica que Bash esté instalado correctamente en tu sistema y que el archivo de script se esté ejecutando en un entorno Bash. +- **Otro problema no mencionado**: Si encuentras algún otro problema que no se haya mencionado aquí, por favor, [abre un issue](https://condorcs.net/kmunoz/wazuhdeb/-/issues) en el repositorio para que podamos ayudarte.