Skip to content

Commit 5df92cf

Browse files
author
Felix Peters
committed
docs: add intro, development and contribution notes to readme
1 parent 4bd3603 commit 5df92cf

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ This repository contains the keycloak-spi-trusted-device Keycloak plugin.
55
The goal of this plugin is to enable users who log in using multi-factor authentication to trust
66
their device, so they do not have to provide a second factor when using that device.
77

8+
The feature is mentioned as a native capability in Keycloak [here](https://github.com/keycloak/keycloak/issues/8742),
9+
but it has not been implemented yet, and it's uncertain if it ever will be.
10+
Therefore, we are currently implementing it as an extension.
11+
12+
The functionality is illustrated in the following diagram. Details about the individual components are provided below.
13+
814
![Authentication flow](doc/authentication-flow.png)
915

1016
## Usage
@@ -38,3 +44,24 @@ During login the user will be prompted if they want to trust the device:
3844
They can then manage their trusted devices on the account console:
3945

4046
![](doc/account-console.png)
47+
48+
## Development
49+
50+
To set up a local environment, first build the extension using Maven. Then, build a Docker image and start the Docker Compose stack.
51+
52+
```bash
53+
mvn package -DskipTests
54+
docker-compose up --build -d
55+
```
56+
57+
A helper script including this command can be found [here](run-dev.sh)
58+
59+
## Testing
60+
61+
Testing is not implemented yet.
62+
63+
## Contributions Welcome
64+
65+
We welcome contributions from the community! If you would like to contribute, please submit a merge request.
66+
If you have any questions or encounter any issues, feel free to open an issue.
67+
We appreciate your help in improving this project.

0 commit comments

Comments
 (0)