Skip to content
View ligoj's full-sized avatar

Block or report ligoj

Block user

Prevent this user from interacting with your repositories and sending you notifications. Learn more about blocking users.

You must be logged in to block users.

Maximum 250 characters. Please don’t include any personal information such as legal names or email addresses. Markdown is supported. This note will only be visible to you.
Report abuse

Contact GitHub support about this user’s behavior. Learn more about reporting abuse.

Report abuse
ligoj/README.md

🔗 Ligoj

The open-source project portal: one place that centralizes every tool of your projects — issue trackers, CI, SCM, quality, cloud provisioning… — with plugin-based connections, fine-grained security and data collection.

Docker API Docker UI Coverage Codacy Badge CodeFactor FOSSA Status License

Ligoj home page

Vue 3 Vite Vuetify Java 25 Spring Boot Docker

Why Ligoj?

  • 🧩 Everything is a plugin — tools, identity providers, features. Pick from the published plugins (Jira, Jenkins, SonarQube, GitHub/GitLab, LDAP, AWS/Azure/OVH provisioning…) or write your own. Install, update and remove them from the UI or the CLI, without rebuilding Ligoj.
  • 🗂️ Projects & subscriptions — each project subscribes to tool instances; health, metrics and key data are collected and displayed on one dashboard.
  • 🔐 Security first — (O)RBAC model with regex-based UI/API authorizations, delegated administration, API tokens, session/OAuth2 (OIDC) login, audit trail and signed plugins. See Security.
  • 💸 Cloud cost management — the provisioning plugins (AWS, Azure, OVH, Outscale…) bring catalog-aware cost estimation and optimization to your projects.
  • Modern stack — Vue 3 + Vuetify 4 SPA (dark mode, i18n EN/FR, mobile-friendly) on a Java 25 / Spring Boot REST API, shipped as Docker images.
  • 🤖 API-first — every feature is a REST endpoint, browsable from the built-in OpenAPI explorer and scriptable through the CLI.

Get started

Runs with podman compose (or Docker Compose — see Prerequisites):

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 http://localhost:8080/ligoj and log in:

Role Login Password
Administrator ligoj-admin ligoj-admin
Regular user ligoj-user ligoj-user

Compose variables, MySQL/PostgreSQL choice, persistent home and image publishing are covered in Deployment with Docker Compose.

Documentation

📖 The full documentation lives in DOC.md — this page is only the front door.

Topic Where
Architecture & topology Architecture
Features (security, audit, hooks, files, pagination…) Features
Security & (O)RBAC model Security
Plugin model, installation & code signing Plugin management
Writing a plugin Creating your own plugin · plugin-api
UI architecture (Vue 3 host + plugin bundles) UI · Frontend development
Backend development, database, packaging Development · Wiki
Docker installation & configuration reference Docker Installation
Branding / custom UI Customization of the UI
REST API & OpenAPI schema OpenAPI
SBOM & management endpoints Management endpoints

Container-specific details: app-api · app-ui.

License

MITFOSSA Status

Pinned Loading

  1. ligoj ligoj Public

    Ligoj, your enhanced project dependencies management

    JavaScript 11 11

  2. ligoj-api ligoj-api Public

    Base components and archetype for plugin of Ligoj

    Java 6 6

  3. plugin-prov plugin-prov Public

    Ligoj plugin for provisioning : design and execution with Terraform

    Java 9 5

  4. plugin-prov-aws plugin-prov-aws Public

    Ligoj plugin for AWS provisioning : fetch prices and Terraform implementation

    Java 4 1

  5. plugin-vm plugin-vm Public

    Ligoj plugin for VM runtime management : scheduled/manual ON/OFF with status pooling

    Java 5

  6. plugin-id plugin-id Public

    Ligoj plugin for identity (IAM) service. Delegation, user, group, companies with full UI

    Java 4 5