From 0ff83c60f400d3339e49ad53b60ace875ab22242 Mon Sep 17 00:00:00 2001 From: decentral1se Date: Sun, 13 Jun 2021 12:32:15 +0200 Subject: [PATCH] Add feature set docs [ci skip] --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index dd3bda4..97833d1 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,17 @@ usability which is often lacking in Enterprise Software ™ environments (Keycloak is made within the context of RedHat / IBM). This is the No Admins, No Masters edition of Keycloak. +## Feature set + +- **invite links**: + - Any collective member with an existing Keycloak account can log in and generate them + - They are valid for 30 days by default (configurable via `INVITE_TIME_LIMIT`) + - Anyone with an invite link can create an account on the Keycloak, so don't share publicly! + - There is no access granularity on the account creation implemented yet, so the accounts are "global" + - Once the user fills in their name, email, password they will receive an email verification mail + +If you want a feature implemented, please open an issue to discuss. + ## Getting Started ### From a system administrator perspective