Here you will find the available versions of Pirolab, both client and server, as well as the necessary instructions to start the application.

For Pirolab to work, a PIROLAB server must be installed either on your local machine or on a machine within your local network. The operating system of the server machine is irrelevant, as the application is distributed via a Docker image.

The client application is currently configured to run on Windows, although a Linux version will be released in future versions.

To use the application, both the server and the client must be installed.

Install the client

To install the client, simply unzip the ZIP file and double-click the installer. Once the installation process starts, follow the on-screen instructions.

You can create a shortcut on the desktop or in the Windows start menu. Once the installation is complete, you can launch the application with a double click.


If there is no connection to the server, a warning message will be displayed.

Install the backend

The backend is distributed as a Docker image, therefore Docker must be installed in order to install the Pirolab server. Docker installation instructions can be found on the official website:
https://www.docker.com/

Once Docker is installed on the machine where you want to run the Pirolab backend, download the corresponding backend-pirolab-x-x-x package.

This package contains everything needed to run a complete local environment with:

All components are containerized using Docker and can be installed on any system with Docker installed.

Initial configuration

First, edit the .env file with your credentials:

DB_ROOT_PASSWORD=your_root_password
DB_NAME=PIROLAB
DB_USER=pirolab
DB_PASSWORD=your_user_password

🔐 This file must never be shared. It contains sensitive information.

Startup

From the project folder (pirolab/), run:

docker compose up --build -d

⏱️ The first execution may take between 2 and 5 minutes (image build and MariaDB download).

Service access

  • OpenProdoc: http://localhost:8080
  • Spring Boot: http://localhost:8090
  • MariaDB: localhost:3306

✅ Documents and database data are preserved between restarts thanks to Docker volumes.

Stop the environment

docker compose down

⚠️ This stops the containers but keeps all data (documents, database, etc.).

To remove everything (including data):

docker compose down -v

Update the application

If you update the Spring Boot or OpenProdoc code:

  1. Replace the springboot/your-app.jar file or the OpenProdoc files.
  2. Rebuild the environment:
docker compose up --build -d

Project structure

pirolab/
├── docker-compose.yml # Service definitions
├── .env.example # Configuration template
├── .env # ← Create this file (not distributed)
├── springboot/ # Spring Boot backend
│ ├── Dockerfile
│ └── your-app.jar
└── openprodoc/ # Document management system
├── Dockerfile
└── (application files)

Common troubleshooting

🔸 “Access denied for user ‘xxx’@’…'”
Make sure the credentials in the .env file match those used by the backend.
If this is the first installation, do not run docker compose down -v after installing OpenProdoc.

🔸 OpenProdoc does not load
Wait about 30 seconds the first time (startup may take longer).
Check the logs:

docker logs openprodoc

🔸 Spring Boot cannot connect to MariaDB
Verify that the DB_* variables in the .env file are correct.
Ensure the backend uses the service name mariadb instead of localhost.

Distribution and security

Never include the .env file in shared files, repositories, or backups.
To share this environment, send the folder without the .env file and always include .env.example.

Support

For questions or issues, contact the system administrator:
📧 sol.licituds@pirolab.cat

🌱 This environment is designed for development and testing. For production use, review the security configuration.

Download the latest client version: http://pirolab.cat/index.php/download/frontend-pirolab-0-0-2/

Download the latest backend version: http://pirolab.cat/index.php/download/backend-pirolab-0-0-2/