Feijuca.Keycloak.MultiTenancy 1.0.2

<a id="readme-top"></a>

About The Project

This project has a quickly purpose: Extend the behavior of keycloak-authorization-services-dotnet but adding a multi-tenancy support. Maybe you are asking yourself, what is feijuca? Well... Feijuca is a nickname for a famous Brazilian dish called Feijoada. I wanted to use a name representing my country on this project and Feijuca was chosen.

Motivation

Keycloak may not be the best solution to work with multi-tenancy authentication, but we have the possibility of achieving this using the multi-realm context, basically we can have multi-realms within a keycloak instance and you can treat each realm as a tenant within your application. Therefore, this project aims to provide a model where this objective can be achieved. 😄

Built With

<img src="https://img.shields.io/badge/dotnet8-blue" />

Prerequisites

This project was made with the purpose to attend only applications that follows the current .Net Supported versions.

Getting Started

Well, as explained previously, this project is just a quicky extension to add multi tenancy support following everything that is done in the keycloak-authorization-services-dotnet. So as a first step you should make the settings according to what is described in the documentation for this project and first of all understand what was written on the documentation.

Installation

Below is an example of how you can configure your application to accomplish the goal to use multi tenancy besed on keycloak realms

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git
   

3. Install NPM packages

   npm install
   

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';
   

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact