Skip to content

Requirements

Roberta Takenaka edited this page Sep 24, 2024 · 3 revisions

Translation: Lilian Calò, 04-Mar-2024 Update: Development team, 24-Set-2024

Back to Table of Contents

The requirements for installing the Website (opac) and Upload application are highly related to the number of articles in the collection. The amount of space is estimated based on the number of articles. The number of requests and simultaneous user accesses should be used to define the amount of processors and memory.

Website (opac) Requirements

Ideal

  • 4 GB to run the containers.
  • 4 processors with 64-bit architecture.

Minimum

  • At least 50 GB of disk space to store MongoDB and MinIO data.
  • At least 1 GB of memory to run the containers.
  • At least one processor with 64-bit architecture.

Hard disk

  • On average, 1 Gb for 10,000 articles for the MongoDB database.
  • Space for other files, such as temporary files, access logs and others.

Upload Requirements

Ideal

  • At least 4 GB of memory to run the containers.
  • At least 4 processors with 64-bit architecture.

Minimum

  • At least 2 GB of memory to run the containers.
  • At least two processors with 64-bit architecture.

Hard disk

Estimated total of 50 Gb for 10,000 articles:

  • migrated files: check the space used in htdocs/img, bases/xml, bases/pdf, bases/translation. On average, 20 Gb for 10,000 articles;
  • new files and their versions: on average, 20 Gb for 10,000 articles;
  • Postgres database: on average, 10 Gb for 10,000 articles;
  • MinIO: check the space used in htdocs/img, bases/xml, bases/pdf, bases/translation. On average, 20 Gb for 10,000 articles;
  • other files, such as temporary files, original zip packages and others.

Other Requirements

  • hub.docker.com account

  • impersonal email for use of the APIs, mainly because it is not possible to have duplicate emails registered in the system

  • to have an email server / service

  • conversion of databases, i.e. binary files with .mst and .xrf extensions, to text files with .id extension

  • access to the classic website folders (bases/xml, bases/pdf, bases/translation, bases-work/*, serial) with reading permission

  • Linux server utilities:

    • Makefile: to start the application. The Makefile simplifies the execution of various Docker and docker-compose commands, which makes the application startup process faster and less prone to errors.
    • Docker and Docker-compose: Docker ensures the operational consistency of the application in different environments by packaging applications in isolated containers. Docker-Compose, in turn, is used to define and manage the execution of these containers. The settings required for this are detailed in a file called docker-compose.yml
    • git

Back to Table of Contents