A web application to centralize the related tools of your projects, a dynamic connection management with security and data collection.

More technical details can be found in the subdirectories ligoj-api and ligoj-ui.

📖 Full documentation lives in DOC.md — architecture, security (O)RBAC model, features, plugin development, deployment, the complete configuration reference and troubleshooting. This page is the quick-start; deep-dive links below point into DOC.md.

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs

                     :8080                    :8081
 Navigateur  ──────>  ligoj-ui  ──────────>  ligoj-api  ──────>  ligoj-db
 (Vue 3 SPA)         Spring Boot             Spring Boot          MySQL 8
                     + fichiers Vue          REST API
                     + proxy REST            + plugins Java

See Architecture for the full topology.

Sans plugin IAM (LDAP/AD), le systeme utilise feature:iam:empty. Les pages Identity affichent les donnees retournees par l'API (qui peuvent etre vides). Les pages Projects et Delegates utilisent les vraies donnees MySQL.

The stack builds and runs with podman compose. On a machine that already has Docker Compose, Podman must be told to prefer podman-compose — see Prerequisites for the one-time provider setup and the sanity check.

Quick install:

# macOS
brew install podman podman-compose git && podman machine init && podman machine start
# Linux (Debian/Ubuntu): sudo apt install -y podman python3-pip git && pip install --user podman-compose

git clone https://github.com/ligoj/ligoj.git && cd ligoj
podman compose -p ligoj -f compose.yml -f compose-override.yml up -d --build

Then open Ligoj Home in your browser.

For RBAC security, install: plugin-id, plugin-id-ldap, plugin-id-ldap-embedded.

More deployment topics — Compose variables, MySQL/PostgreSQL selection, persistent home, embedding git provenance, one-script setup and publishing images to AWS ECR — are documented in Deployment with Docker Compose.

See the Development and Frontend development (Vite) guides, and the Wiki page.

See each container ligoj-api and ligoj-ui.

API is only available from a valid session. See OpenAPI / API schema.

• Swagger UI page
• WADL

Ligoj is massively based on plugin management. All plugins are deployed in Maven central. To build and deploy a plugin, more information is available in the plugin-api repository. See Plugin management for the full model.

Ligoj comes with a modular approach: the UI can be rebranded or extended by rebuilding plugin-ui, shipping your own plugin-ui-company, or dropping assets into the Ligoj home directory. See Custom UI via plugins and Customization of the UI.

SBOM content is exposed thanks to Spring Actuator at http://localhost:8080/ligoj/manage/sbom. See Management endpoints.