refs #1084 - Modify documentation

README.md

@@ -7,8 +7,35 @@ Este repositorio GIT contiene la estructura de datos del repositorio de imágene
 - **admin** --- Archivos de configuración de ogRepository.  
 - **api** ------ API de ogRepository.  
 - **bin** ------ Scripts en Python 3 y binarios de gestión de ogRepository.    
-- **etc** ------ Ficheros y plantillas de configuración de ogRepository.    
+- **etc** ------ Ficheros y plantillas de configuración de ogRepository.  
+- **packets** - Paquetes cuya intalación es requerida.    
 
+---
+
+## Requerimientos:
+
+Paquetes APT requeridos:
+  - **uftp** (se puede instalar con "sudo DEBIAN_FRONTEND=noninteractive apt install uftp -y", para que no pida la ruta predeterminada)
+  - **udpcast** (se puede instalar con "sudo apt install ./udpcast_20230924_amd64.deb", apuntando al paquete, que debe descargarse previamente)
+  - **ctorrent** (se puede instalar con "sudo apt install ctorrent")  
+  - **bittorrent** (se puede instalar con "sudo apt install bittorrent", pero previamente hay que añadir un repositorio de Debian)  
+  - **bittornado** (se puede instalar con "sudo apt install bittornado", pero previamente hay que añadir un repositorio de Debian)  
+  
+Librerías Python requeridas:
+  - **flask** (se puede instalar con "sudo apt install python3-flask")    
+  - **paramiko** (se puede instalar con "sudo apt install python3-paramiko")
+  - **psutil** (se puede instalar con "sudo apt install python3-psutil")                          
+  - **flasgger** (se puede instalar con "sudo apt install python3-flasgger")
+
+Para que todos los endpoints y scripts funcionen con la configuración actual deben existir los siguientes directorios:
+  - **/opt/opengnsys/images/**
+  - **/opt/opengnsys/images_trash/** (debe estar en la misma unidad que el anterior, o tardarán mucho las eliminaciones y restauraciones)
+  - **/opt/opengnsys/bin/** (aquí deben estar todos los scripts de Python, y el binario "udp-sender")
+  - **/opt/opengnsys/etc/** (aquí se guardan los archivos "repoinfo.json" y "trashinfo.json")
+  - **/opt/opengnsys/log/** (aquí se guardan los logs)
+
+Y también debe existir el siguiente archivo:
+  - **/opt/opengnsys/etc/ogAdmRepo.cfg** (de aquí pilla la IP de ogRepository)
 
 ---
 

api/swagger.yaml

@@ -7,21 +7,24 @@ info:
     
     **API de ogRepository, programada en Flask**.  
     
-    Responde a peticiones HTTP (enviadas desde ogCore) mediante endpoints, que a su vez ejecutan los scripts Python almacenados en ogRepository.
-    En ciertos casos, transforma los parámetros recibidos desde el portal, para adaptarlos a los que es necesario enviar a los scripts (por ejemplo, a partir del ID de una imagen obtiene su nombre, su extensión y el subdirectorio de OU).
+    Responde a peticiones HTTP mediante endpoints, que a su vez ejecutan los scripts de Python 3 almacenados en ogRepository. En el entorno real, estas peticiones HTTP se enviarán desde ogCore.
+    En la mayoría de los casos, transforma los parámetros recibidos para adaptarlos a los que es necesario enviar a los scripts (por ejemplo, a partir del ID de una imagen obtiene su nombre, su extensión y el subdirectorio de OU).
     
+    ---
+
+    Paquetes APT requeridos:
+      - **uftp** (se puede instalar con "sudo DEBIAN_FRONTEND=noninteractive apt install uftp -y", para que no pida la ruta predeterminada)
+      - **udpcast** (se puede instalar con "sudo apt install ./udpcast_20230924_amd64.deb", apuntando al paquete, que debe descargarse previamente)
+      - **ctorrent** (se puede instalar con "sudo apt install ctorrent")
+      - **bittorrent** (se puede instalar con "sudo apt install bittorrent", pero previamente hay que añadir un repositorio de Debian)
+      - **bittornado** (se puede instalar con "sudo apt install bittornado", pero previamente hay que añadir un repositorio de Debian)
+      
     Librerías Python requeridas:
       - **flask** (se puede instalar con "sudo apt install python3-flask")  
       - **paramiko** (se puede instalar con "sudo apt install python3-paramiko")
       - **psutil** (se puede instalar con "sudo apt install python3-psutil")                          
-      - **requests** (se puede instalar con "sudo apt install python3-requests") - No tengo claro que para este paquete sea necesario
       - **flasgger** (se puede instalar con "sudo apt install python3-flasgger")
 
-    Paquetes APT requeridos:
-      - **uftp** (se puede instalar con "sudo DEBIAN_FRONTEND=noninteractive apt install uftp -y", para que no pida la ruta predeterminada)
-      - **ctorrent** (se puede instalar con "sudo apt install ctorrent")
-      - **udpcast** (se puede instalar con "sudo apt install ./udpcast_20230924_amd64.deb", apuntando al paquete)
-
     Para que todos los endpoints de la API funcionen con la configuración actual deben existir los siguientes directorios:
       - **/opt/opengnsys/images/**
       - **/opt/opengnsys/images_trash/** (debe estar en la misma unidad que el anterior, o tardarán mucho las eliminaciones y restauraciones)
@@ -30,7 +33,7 @@ info:
       - **/opt/opengnsys/log/** (aquí se guardan los logs)
 
     Y también debe existir el siguiente archivo:
-      - **/opt/opengnsys/etc/ogAdmRepo.cfg** (de aquí pilla la IP de ogRepo)
+      - **/opt/opengnsys/etc/ogAdmRepo.cfg** (de aquí pilla la IP de ogRepository)
 
     ---