From d26e3aa78d70065bef4df7b389dbd043fdf88b78 Mon Sep 17 00:00:00 2001 From: d3hof Date: Thu, 12 May 2022 13:48:21 +0200 Subject: [PATCH] added documentation --- .gitignore | 3 +- README.md | 27 +++++++++++- docker-compose.yml | 3 +- keycloak-scim.iml | 106 +++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 135 insertions(+), 4 deletions(-) create mode 100644 keycloak-scim.iml diff --git a/.gitignore b/.gitignore index c41cc9e35e..40d9acab97 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ -/target \ No newline at end of file +/target +/.idea \ No newline at end of file diff --git a/README.md b/README.md index 07394eaaf3..b319f87fa1 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,15 @@ Because the event listener is the source of the SCIM flow, and it is not cancela 1. Download the [latest version](https://lab.libreho.st/libre.sh/scim/keycloak-scim/-/jobs/artifacts/main/raw/target/keycloak-scim-1.0-SNAPSHOT-jar-with-dependencies.jar?job=package) 2. Put it in `/opt/jboss/keycloak/standalone/deployments/`. +It's also possible to build your own custom image if you run keycloak in a container. + +Example: +``` +FROM jboss/keycloak:16.1.1 + +COPY keycloak-scim-1.0-SNAPSHOT-jar-with-dependencies.jar /opt/jboss/keycloak/standalone/deployments/keycloak-scim-1.0-SNAPSHOT.jar +``` + ### Setup #### Add the event listerner @@ -56,11 +65,25 @@ Because the event listener is the source of the SCIM flow, and it is not cancela ### Configuration -TODO +Add the endpoint - for a local set up you have to add the two containers in a docker network and use the container ip see (here)[https://docs.docker.com/engine/reference/commandline/network/] +If you use the (rocketchat app)[https://lab.libreho.st/libre.sh/scim/rocketchat-scim] you get the endpoint from your rocket Chat Scim Adapter App Details. +Endpoint content type is application/json. +Auth mode Bearer or None for local test setup. +Copy the bearer token from your app details in rocketchat. + +If you enable import during sync then you can choose between to following import actions: +- Create Local - adds users to keycloak +- Nothing +- Delete Remote - deletes users from the remote application + + + ### Sync -TODO +You can set up a periodic sync for all users or just changed users - it's not necesarry. You can either do: +- Periodic Full Sync +- Periodic Changed User Sync **[License AGPL](/LICENSE)** diff --git a/docker-compose.yml b/docker-compose.yml index 7bb40ee5d8..3c090232a6 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -23,8 +23,9 @@ services: DB_PASSWORD: keycloak KEYCLOAK_USER: admin KEYCLOAK_PASSWORD: admin + KEYCLOAK_LOGLEVEL: DEBUG ports: - - 8080:8080 + - 127.0.0.1:8080:8080 depends_on: - postgres diff --git a/keycloak-scim.iml b/keycloak-scim.iml new file mode 100644 index 0000000000..414103a5e4 --- /dev/null +++ b/keycloak-scim.iml @@ -0,0 +1,106 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file