# README
Traefik OpenID Connect Middleware
A traefik Plugin for securing the upstream service with OpenID Connect acting as a relying party.
[!NOTE] This document always represents the latest version, which may not have been released yet. Therefore, some features may not be available currently but will be available soon. You can use the GIT-Tags to check individual versions.
[!WARNING] This middleware is under active development and breaking changes may occur.
Tested Providers
Provider | Status | Notes |
---|---|---|
ZITADEL | ✅ | |
Kanidm | ✅ | See GH-12 |
Keycloak | ✅ | |
Microsoft EntraID | ⚠️ | See GH-15 |
HashiCorp Vault | ❌ | See GH-13 |
📚 Documentation
Please see the full documentation HERE.
🧪 Local Development and Testing
Create the following .env
file:
PROVIDER_URL=...
CLIENT_ID=...
CLIENT_SECRET=...
The run docker compose up
to run traefik locally.
Now browse to http://localhost:9080. You should be redirected to your IDP. After you've logged in, you should be redirected back to http://localhost:9080 and see a WHOAMI page.