From 91530d13abc2b8ae747cbaf2a810fdf4735c0d47 Mon Sep 17 00:00:00 2001 From: Matthieu Bessat Date: Wed, 4 Dec 2024 19:52:59 +0100 Subject: [PATCH] docs: update README --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5762d48..47d1545 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # Minauthator -Minauthator is an identity provider supporting [OpenID Connect (OIDC)](https://en.wikipedia.org/wiki/OpenID_Connect). +Minauthator is an identity provider server supporting [OpenID Connect (OIDC)](https://en.wikipedia.org/wiki/OpenID_Connect). -This project aims to allow an organization to setup [single sign-on (SSO)](https://en.wikipedia.org/wiki/Single_sign-on) using a self-hosted free software. +This project aims to allow an organization to setup [single sign-on (SSO)](https://en.wikipedia.org/wiki/Single_sign-on) using a self-hosted free software (FOSS). + +This project also aims to provide features while being frugal and minimalist. **Project status: *early development, work-in-progress*** @@ -14,6 +16,8 @@ This project aims to allow an organization to setup [single sign-on (SSO)](https - [x] Activation token - [x] Profile details - [x] Static apps +- [x] Admin CLI to manage user. +- [x] User invitation with human token - [ ] User roles - [ ] User groups - [ ] MFA/TOTP @@ -21,6 +25,20 @@ This project aims to allow an organization to setup [single sign-on (SSO)](https - [ ] Login page customization - [x] App listing (App presentation to users) - [x] Implicit OAuth 2.0 flow +- [ ] Email verification +- [ ] GPG keys verification and signing +- [ ] Docker deployment + +## Architecture + +- Sqlite DB +- Kernel +- Http server + - Public API + - User API + - Third-party OAuth2 app/client API + - Web GUI (no Javascript) +- Admin CLI ## Deps @@ -30,4 +48,4 @@ This project aims to allow an organization to setup [single sign-on (SSO)](https - [Authentik](https://goauthentik.io/) - [Keycloak](https://www.keycloak.org/) - +- [Kanidm](https://kanidm.com/)