Unleash OIDC Integration

This docker image OpenID Connect (OIDC) authentication with Unleash, a feature management solution. The integration allows users to authenticate via an OIDC provider before accessing the Unleash admin interface.

Table of Contents

• Prerequisites
• Configuration
• Docker
• Contributing
• License

Prerequisites

Before you begin, ensure you have the following:

• Docker and Docker Compose installed
• An OIDC provider (e.g., Keycloak, Auth0) configured with a client ID and client secret

Configuration

Set the following environment variables in your .env file or directly in your environment:

• UNLEASH_HOST: The host URL for your Unleash instance.
• CONTEXT_PATH: The context path for your Unleash instance (default is an empty string).
• AUTH_HOST: The host URL for your OIDC provider.
• AUTH_REALM: The realm for your OIDC provider.
• AUTH_CLIENT_ID: The client ID for your OIDC application.
• AUTH_CLIENT_SECRET: The client secret for your OIDC application.

Example .env file:

UNLEASH_HOST=http://localhost:4242
CONTEXT_PATH=/unleash
AUTH_HOST=https://auth.example.com
AUTH_REALM=myrealm
AUTH_CLIENT_ID=myclientid
AUTH_CLIENT_SECRET=myclientsecret

Docker

This image is built out of the recommended base image from unleash. Refer to the Unleash Docker documentation for more information.

You can run this project using Docker:

1. Build the Docker image:

   docker build -t unleash-oidc .

2. Run the Docker container:

   docker run -p 4242:4242 --env-file .env unleash-oidc

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.