Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

59 lines (40 loc) · 1.75 KB

Contributing to GLPI Docker Images

Thank you for your interest in contributing to the GLPI Docker images project!

This guide will help you set up your local development environment to test changes.

Prerequisites

  • Docker installed.
  • jq (optional, for the download script).

Setup Development Environment

To verify that the Docker image builds and runs correctly, you need to populate the ./glpi/sources directory with the GLPI source code.

1. Download GLPI Sources

We provide a helper script to automatically fetch and extract the GLPI source code.

Download the latest stable version (jq required):

./download_sources.sh

Download a specific version (e.g. 10.0.16):

./download_sources.sh 10.0.16

Note: This script downloads the source code archive from GitHub into glpi/sources. This is required for the Docker build process (Dockerfile copies content from this directory).

2. Run the Test Environment

We provide a docker-compose.test.yml file designed to test the glpi container.

Run the stack (builds the image and starts GLPI + MariaDB):

docker compose -f docker-compose.test.yml up --build

3. Verify

Once the containers are up:

  1. Check the logs to see the installation progress: 
    docker compose -f docker-compose.test.yml logs -f glpi
  2. Wait for the "GLPI installation completed successfully!" message.
  3. Access GLPI at http://localhost:8080.
    • User: glpi
    • Password: glpi

4. Cleanup

To stop and remove the test containers:

docker compose -f docker-compose.test.yml down -v