Instalación en una máquina local

Es importante destacar que existen requerimientos mínimos de hardware para poder ejecutar el aplicativo en función de las herramientas que se deseen utilizar. A continuación, se presenta una tabla que describe las distintas funciones junto con sus requerimientos mínimos correspondientes.

Descripción	Requerimientos
Módulo de catalogación: Esta funcionalidad permite catalogar y organizar nuevos recursos en base a un formulario descrito por el usuario. Los procesamientos deben estar límitados a uno al tiempo para evitar sobrecargar la máquina.	4GB RAM
Búsqueda avanzada con cruces de información relacionada al procesamiento de texto, OCR, transcripción y etiquetado automático.	16GB RAM

Instalación de Docker en la máquina

Para instalar ArchiHUB en una máquina local, es necesario contar con el aplicativo Docker instalado en el sistema operativo (ya sea Mac o Windows). Docker es una herramienta que permite virtualizar los diferentes servicios necesarios para el correcto funcionamiento del archivo. A lo largo de esta guía, se mostrará cómo utilizar esta herramienta para poner en marcha el archivo, realizar copias de seguridad y actualizar la herramienta.

Descargar ArchiHUB

El sistema ArchiHUB está compuesto por dos componentes principales:

Backend: Una API que sirve como base del sistema
Frontend: Componente intercambiable que puede adaptarse según necesidades específicas

Actualmente existe una versión del frontend que gestiona todas las tareas de procesamiento y manejo de archivos. Sin embargo, esta implementación no limita el sistema, ya que permite desarrollar interfaces personalizadas según los requerimientos de cada usuario.

Preparación de la instalación

Este repositorio centraliza las diferentes formas de instalar ArchiHUB. Para nuestro caso, necesitaremos los archivos ubicados en la carpeta local-machine.

Importante: Antes de comenzar, debes:

Actualizar las claves de acceso
Ajustar las configuraciones de seguridad

Esto garantizará que la instalación sea segura y funcione correctamente desde el inicio.

Configuración del entorno

Sigue estos pasos para preparar el entorno:

Descargar el repositorio con los scripts de instalación
Ventana de terminal
```
git clone https://github.com/ArchiHUB-App/getting-started
```
Ir a la carpeta archihub
Ventana de terminal
```
cd getting-started/local-machine/archihub
```
Renombrar el archivo .env.bak a .env
Ventana de terminal
```
mv .env.back .env
```

Asegúrate de ajustar las siguientes configuraciones en este archivo para que todo funcione correctamente:

Línea 7: MONGO_INITDB_ROOT_PASSWORD es la variable de entorno que le asigna una contraseña a la base de datos.
Línea 11: ELASTIC_PASSWORD es la variable de entorno que le asigna una constraseña al índice de elasticsearch.
Línea 29 y 30: SECRET_KEY y JWT_SECRET_KEY son para las llaves de ingreso al aplicativo.
Línea 31: FERNET_KEY es la llave que se usa para encriptar nuestras llaves de acceso a la API.

Herramientas útiles

Enlace para generar aleatoriamente una contraseña.

Enlace para generar llave fernet.

Organización de las carpetas

├── local-machine
│   ├── archihub
│   │   ├── frontend
│   │   ├── backend
│   │   ├── mongo_db
│   ├── webfiles
│   ├── userfiles
│   ├── temporal
│   ├── original
│   ├── data
│   │   ├── mongodb
│   │   ├── elastic

La raiz de la carpeta está compuesta por las siguientes carpetas, si no existen se deben crear:

archihub: en esta carpeta encontramos el código del frontend, el backend debemos descargarlo o clonarlo del repositorio y en mongo_db se encuentra la configuración inicial del aplicativo para cargar a una instalación fresca de la base de datos.
webfiles: ArchiHUB soporta una amplia variedad de documentos que puedes cargar sin preocuparte por el formato. Para facilitar la visualización y estandarizar los formatos, nuestra herramienta se encarga de generar versiones web de los documentos. Esto te permite acceder y ver tus archivos de manera consistente y sin complicaciones, independientemente del formato original.
userfiles: en esta carpeta se guardan los archivos generados por los usuarios, pueden ser reportes de procesamiento masivo o inventarios que se solicitan desde el módulo de catalogación.
temporal: para algunos casos de procesamiento es necesario manipular archivos temporal, esta carpeta se usa para eso.
original: acá se almacenan los archivos originales de los documentos. Se guardan en una estructura temporal de carpetas y la ruta del original es la misma que la de las versiones web.
data: estos son los datos persistentes tanto de la base de datos como del índice. Esta carpeta es para uso exclusivo del sistema y no debe ser modificada.

Descargar el backend del aplicativo

Como mencionamos anteriormente, es necesario descargar el código del backend desde el repositorio del proyecto. Puedes hacerlo de dos maneras:

Clonar el repositorio
Ventana de terminal
```
git clone https://github.com/ArchiHUB-App/archihub-backend.git backend
```
Este comando debe ejecutarse dentro de la carpeta /local-machine/archihub/ y creará una carpeta llamada “backend”.
O descargar el zip

Esto te permitirá obtener todo el código necesario para configurar y ejecutar el backend de ArchiHUB.

Arrancar el aplicativo

Ejecutar el comando de despliegue
Ventana de terminal
```
docker compose up -d
```
Este comando iniciará el despliegue de todos los servicios necesarios.
Verificar el estado de los servicios Puedes verificar el estado de dos maneras:

Opción 1 - Docker Desktop:
- Abre la aplicación Docker Desktop
- Ve a la pestaña “Containers”
- Verifica que aparezca archihub como activo
Opción 2 - Terminal:
Ventana de terminal
```
docker ps
```
Este comando mostrará todos los contenedores activos. Deberías ver los contenedores de ArchiHUB en la lista.
Acceder a la aplicación
- Abre tu navegador web
- Ve a http://localhost/
- La instalación puede tomar unos minutos, sé paciente

Nota: Si los servicios no aparecen como activos, espera unos minutos y verifica nuevamente. La primera instalación puede tomar más tiempo.

El usuario por defecto de esta instalación es beta y la contraseña beta.

Una vez estés listo podemos seguir con los primeros pasos en ArchiHUB.