From d5a1285e34408a774cfa6ea48a5e76bb13b98cd2 Mon Sep 17 00:00:00 2001
From: Elian Loraux <elian.loraux@tetras-libre.fr>
Date: Tue, 20 Aug 2024 15:01:47 +0200
Subject: [PATCH] change readme to generic
---
README.md | 24 +++++++++++-------------
1 file changed, 11 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index bbb9b74..e6f9068 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,6 @@
-# SSO FFCU
+# Keycloak
This is dockerised Keycloak system. Keycloak support openid_connect.
-This project is part of "Transformation Numérique" project from FFCU (https://www.uncu.fr/).
It's designed to be connected to a Dolibarr instance and other partners applciations.
## Setting up your environement
@@ -14,11 +13,11 @@ It's designed to be connected to a Dolibarr instance and other partners applciat
`docker-compose up`
-## Configuration
+## Configuration
-### Create realm, first user and connect first application
+### Create realm, first user and connect first application
-Follow the official [get started tutorial](https://www.keycloak.org/getting-started/getting-started-docker)
+Follow the official [get started tutorial](https://www.keycloak.org/getting-started/getting-started-docker)
### Link a Dolibarr instance to Keycloak
@@ -34,8 +33,8 @@ To set up SSO with dolibarr you need folow this insctruction :
2. Generate the dolibarr variable with `dolibarr_variables.py`. If you don't know where to find the information requested by the script, see Prerequisites
3. Put generated variables in Dolibarr > Setup > Other Setup
4. Configure the authentication methods in conf.php (dolibarr_src/htdocs/conf/conf.php) and add openid_connect. `$dolibarr_main_authentication='openid_connect'`
-5.
- - In dev : choose username matching : `preferred_username`
+5.
+ - In dev : choose username matching : `preferred_username`
- In prod : Choose mail matching method
For many information, follow the [dolibarr tutorial](https://wiki.dolibarr.org/index.php?title=Authentication,_SSO_and_SSL#Mode_openid_connect)
@@ -44,15 +43,14 @@ For many information, follow the [dolibarr tutorial](https://wiki.dolibarr.org/i
#### Final config KeyCloak Dolibarr for Prod (WIP)
- In Realm settings > Login, check following options
- - Forgot password
- - Remember me
- - Email as username
- - login with email
+ - Forgot password
+ - Remember me
+ - Email as username
+ - login with email
- verify email
- Realm settings > Email, configur your SMTP parameters + mail informations
- Realm settings > Theme, add your custom theme
- If needed create users group
-- Create your users
+- Create your users
- Client > account-console > sttings
- Set web origins to *
-
--
GitLab