diff --git a/.gitlab/issue_templates/add_entity.md b/.gitlab/issue_templates/add-entity.md similarity index 96% rename from .gitlab/issue_templates/add_entity.md rename to .gitlab/issue_templates/add-entity.md index b45daeea23c563f1ccef9f3f6ec9f585b4c458a0..ababc51e89faf9c265187fe7acc44d5dd1ac6966 100644 --- a/.gitlab/issue_templates/add_entity.md +++ b/.gitlab/issue_templates/add-entity.md @@ -18,11 +18,11 @@ Ici on cherche à ajouter un client au sens commercial qui se traduiras par un r - [ ] Cliquez sur le menu déroulant en dessous du logo Keycloak - [ ] Cliquez sur Create realm -[image] +  - [ ] Entrez le nom de royaume -[image] + ## Configuration du Royaume @@ -35,7 +35,7 @@ Ici on cherche à ajouter un client au sens commercial qui se traduiras par un r - [ ] Aller dans l'onglet "Localization" - [ ] Activez l'option "Internationalization" - [ ] Ajoutez les langues souhaitées -- [ ] Sauvegardez +- [ ] Sauvegarde ## Création du première utilisateur diff --git a/.gitlab/issue_templates/dolibarr-connect.md b/.gitlab/issue_templates/dolibarr-connect.md new file mode 100644 index 0000000000000000000000000000000000000000..fb8bd4646bd9dab8ea43d04555582893d82d36ef --- /dev/null +++ b/.gitlab/issue_templates/dolibarr-connect.md @@ -0,0 +1,32 @@ +# Branchement de Dolibarr sur Keycloak + +## Prérequis + +[Dolibarr dockerisé](https://gitlab.tetras-libre.fr/nocloud/docker/dolibarr) en place. + +Avoir un royaume keycloak et un client dolibarr dans ce royaume + +## Mise en place du SSO sur dolibarr_src + +Pour mettre en place le SSO sur dolibarr il vous faut suivre ses instructions : + +1. [ ] Crée le même utilisateur (avec le même username) dans dolibarr et dans keycloak +2. [ ] Récupérer les informations suivante + - [ ] Domaine Keycloak (ex : keycloak.tetras-libre.fr) + - [ ] Domaine Dolibarr (ex : dolibarr.tetras-libre.fr) + - [ ] Nom du royaume + - [ ] ClientID + 1. Dans keycloak, cliquez sur "Client" + 2. Récupérer le ClientID du client dolibarr  + 3. Récupérer le secret du client  +3. [ ] Générer les variable dolibarr avec le script `dolibarr_variables.py` +4. [ ] Mettre les variables dans Dolibarr > Setup > Other Setup +5. [ ] Configurez la methode d'authentification dans conf.php (dolibarr_src/htdocs/conf/conf.php) en mettant 'openid_connect' `$dolibarr_main_authentication='openid_connect'` +6. [ ] Confugurez le Client keycloak dolibarr + 1. [ ] Activez "Always display in UI" + 2. [ ] Rensaignez "Home URL" avec l'url du dolibarr (ex : dolibarr.tetras-libre.fr) + 3. [ ] Rensaignez "valid redirect URIs" avec l'url du dolibarr suivit de '\/*' (ex : dolibarr.tetras-libre.fr\/*) + 4. [ ] Rensaignez "Web origins" avec l'URL de keyclaok et dolibarr (ex : keycloak.tetras-libre.fr,dolibarr.tetras-libre.fr) + + +Pour plus d'information, suivez le [tutoriel dolibarr](https://wiki.dolibarr.org/index.php?title=Authentication,_SSO_and_SSL#Mode_openid_connect) diff --git a/.gitlab/issue_templates/img/add-realm.png b/.gitlab/issue_templates/img/add-realm.png new file mode 100644 index 0000000000000000000000000000000000000000..eb9a194b0a658ed4c16e725c1b398d5814098451 Binary files /dev/null and b/.gitlab/issue_templates/img/add-realm.png differ diff --git a/.gitlab/issue_templates/img/clientID.png b/.gitlab/issue_templates/img/clientID.png new file mode 100644 index 0000000000000000000000000000000000000000..a5dd0974deb751f7ae4003149635151acb5e9b9b Binary files /dev/null and b/.gitlab/issue_templates/img/clientID.png differ diff --git a/.gitlab/issue_templates/img/name-realm.png b/.gitlab/issue_templates/img/name-realm.png new file mode 100644 index 0000000000000000000000000000000000000000..c21128a9a48ab5f2d3c9a232ffa56048b9991390 Binary files /dev/null and b/.gitlab/issue_templates/img/name-realm.png differ diff --git a/.gitlab/issue_templates/img/secret.png b/.gitlab/issue_templates/img/secret.png new file mode 100644 index 0000000000000000000000000000000000000000..d1d50ed20d38c49b65007864f5e47cd4dc3e02b1 Binary files /dev/null and b/.gitlab/issue_templates/img/secret.png differ diff --git a/README.md b/README.md index e6f9068876756c4e39340b0331a6f415b6936edb..3e7fe61d6782d83542daf5c7d9444cbebd21b369 100644 --- a/README.md +++ b/README.md @@ -15,42 +15,8 @@ It's designed to be connected to a Dolibarr instance and other partners applciat ## Configuration +For realm creation, add custom theme and Dolibarr connection, see issue template (.gitlab/issue_templates) + ### Create realm, first user and connect first application Follow the official [get started tutorial](https://www.keycloak.org/getting-started/getting-started-docker) - -### Link a Dolibarr instance to Keycloak - -#### Prerequisites - -Set un dockerised [Dolibarr](https://gitlab.tetras-libre.fr/nocloud/docker/dolibarr) - -#### Set up Dolibarr - -To set up SSO with dolibarr you need folow this insctruction : - -1. Create user with the same username in dolibarr and keycloak -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` - - 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) - - -#### Final config KeyCloak Dolibarr for Prod (WIP) - -- In Realm settings > Login, check following options - - 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 -- Client > account-console > sttings - - Set web origins to *