Installation on a local machine

It is important to note that there are minimum hardware requirements to be able to run the application depending on the tools to be used. Below is a table describing the different functions and their corresponding minimum requirements.

Description	Requirements
Cataloging module: This functionality allows cataloging and organizing new resources based on a form described by the user. Processing must be limited to one at a time to avoid overloading the machine.	4GB RAM
Advanced search with cross-referencing of information related to word processing, OCR, transcription and automatic labeling.	16GB RAM

Docker installation on the machine

To install ArchiHUB on a local machine, it is necessary to have the Docker application installed on the operating system (either Mac or Windows). Docker is a tool that allows to virtualize the different services necessary for the correct operation of the archive. Throughout this guide, it will be shown how to use this tool to start up the archive, perform backups and update the tool.

• MAC Installation
• Windows installation
• Linux installation

Download ArchiHUB

The ArchiHUB system is composed of two main parts: a backend and a frontend. The backend, being an API, allows the frontend to be an interchangeable component. Currently, there is a version of the frontend that executes all tasks related to archive processing and management. However, this configuration does not restrict the use of the system, since it is possible to develop an interface adapted to the specific needs of each user, depending on their requirements. We will now detail the steps to follow for installation using docker compose. The first step is to clone or download the repository with the installation scripts:

git clone https://github.com/ArchiHUB-App/getting-started

In this repository we find centralized the different ways in which we can start our ArchiHUB installation. For our specific case, we will need the content of the local-machine folder. Before starting the installation process, it is crucial that you update the login keys and adjust some security settings. This will ensure that your installation is secure and that everything runs smoothly from the start.

Environment configuration

To begin, you must go to the /local-machine/archihub folder and create a new .env file by copying the contents found in the .env.back file. You can use the text editor of your choice to perform this task. Be sure to adjust the following settings in this file so that everything works correctly:

• Line 7: MONGO_INITDB_ROOT_PASSWORD is the environment variable that assigns a password to the database. Link to randomly generate a password.
• Line 11: ELASTIC_PASSWORD is the environment variable that assigns a password to the index of elasticsearch. Link to randomly generate a password.
• Line 29 y 30: SECRET_KEY y JWT_SECRET_KEY are for the keys to enter the application. Link to randomly generate a password.
• Line 31: FERNET_KEY is the key used to encrypt our API access keys. Link to generate fernet key.

Folder organization

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

The root of the folder is composed of the following folders, if they do not exist they must be created:

• archihub: in this folder we find the frontend code, the backend we must download or clone it from the repository and in mongo_db we find the initial configuration of the application to load to a fresh installation of the database.
• webfiles: ArchiHUB supports a wide variety of documents that you can upload without worrying about the format. To facilitate viewing and standardize formats, our tool takes care of generating web versions of the documents. This allows you to access and view your files consistently and smoothly, regardless of the original format.
• userfiles: this folder stores files generated by users, such as mass processing reports or inventories requested from the cataloging module.
• temporal: for some processing cases it is necessary to manipulate temporary files, this folder is used for that.
• original: the original files of the documents are stored here. They are stored in a temporary folder structure and the path of the original is the same as that of the web versions.
• data: this is the persistent data from both the database and the index. This folder is for system use only and should not be modified.

Download the application backend

As we mentioned before, it is necessary to download the backend code from the repository of the project. You can do it in two ways:

• Cloning the repository: Use the git clone command to clone the repository, this should be inside the /local-machine/archihub/ folder with the folder name “backend”.
  

  git clone https://github.com/ArchiHUB-App/archihub-backend.git backend

• Downloading the zip file:
  

This will allow you to get all the necessary code to configure and run the ArchiHUB backend.

Starting the application

When we have the environment variables configured and the folders ready, we are ready to start the application using Docker. For this it is necessary to open a terminal and go to the folder where the File tool is located. To do this, type cd (!! do not forget the space at the end) in the terminal and drag the archihub folder to the terminal.

Press “Enter” and then copy and paste the command docker compose up -d and “Enter” to accept. The deployment of the services will start. To check the status of the services, you can open the Docker application and go to the “Containers” tab. There you should see archihub as active.

Usually the installation can take a few minutes. When you are ready you can go to the following link using your browser: http://localhost/

Once you are ready we can continue with the first steps in ArchiHUB.