Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/GuancheData/stage_3/llms.txt

Use this file to discover all available pages before exploring further.

Before you start a single-node or multi-node GuancheData deployment, every machine that will participate in the cluster must have the same set of tools installed. The build pipeline relies on Java and Maven to compile the microservices into executable JARs, while Docker Compose handles image building and container orchestration at runtime. The steps below walk you through installing and verifying each dependency.
1

Install Java JDK 17

GuancheData services are compiled and run on Java 17. Download the JDK from your distribution’s package manager or from Adoptium. After installation, confirm the version:
java -version
Expected output (version number may vary within the 17.x line):
openjdk version "17.0.x" ...
The services will not compile or start on Java versions older than 17. Make sure JAVA_HOME points to a JDK 17 installation if you have multiple JDKs installed.
2

Install Apache Maven 3.6+

The project uses a multi-module Maven build. Maven 3.6 or later is required. Verify the installed version:
mvn -v
Expected output:
Apache Maven 3.x.x ...
Java version: 17.x.x, ...
The output also confirms which JDK Maven is using. Both lines must reflect version 17.
3

Install Docker Desktop

Docker Compose is used to build container images and run all services. Install Docker Desktop (which bundles the Compose plugin) for your operating system from docker.com.Verify the Docker daemon is running and the Compose plugin is available:
docker --version
docker compose version
Expected output:
Docker version 26.x.x, ...
Docker Compose version v2.x.x
No separate docker build step is needed. Docker Compose handles both image building and container startup automatically when you run docker compose up.
4

Install curl (optional)

curl is not required to run the cluster, but it is useful for quick health checks and ad-hoc queries against the search API once the system is running. Verify it is available:
curl --version
If curl is not installed, use your system package manager:
# Debian/Ubuntu
sudo apt install curl

# macOS (Homebrew)
brew install curl
All nodes in a multi-node deployment must have Java JDK 17, Maven 3.6+, and Docker Desktop installed. The Maven build only needs to run on one machine (the machine where you clone the repository), but Docker must be present and running on every node that will host containers.

Build docs developers (and LLMs) love