Getting Started Lab: Permguard + Keycloak

This repository provides a hands-on lab environment to demonstrate how Permguard can be integrated with Keycloak.
It serves as a practical reference for developers experimenting with policy-based access control (PBAC) using Permguard, powered by Keycloak’s IAM.

Prerequisites

Make sure you have the following installed before running the lab:

• Docker and Docker Compose
• Permguard CLI

Optional (depending on what you want to run locally):

• Go 1.24.6+

  Only required if you want to build/run Go components directly.

• Python 3.11.8+

  Only required if you plan to run provisioning scripts outside Docker.

Project Structure

permguard-keycloak-lab/  
├── docs/                # Documentation and diagrams  
├── keycloak/            # Keycloak setup  
│   └── ...  
├── permguard/           # Permguard setup  
│   └── ...  
└── workspace/           # Permguard workspace
    ├── policies/  
    └── ...  

• keycloak/ → contains Keycloak configuration
• permguard/ → contains Permguard configuration
• workspace/ → workspace for Permguard

Run Locally

Clone the repository and start the environment with Docker Compose:

git clone [email protected]:ngallo/permguard-keycloak-lab.gi
cd permguard-keycloak-lab
make up