From d0e6bbf385a483e58ee5ac11a6b7ea8febcba8cb Mon Sep 17 00:00:00 2001 From: d3hof Date: Thu, 12 May 2022 14:42:23 +0200 Subject: [PATCH] added Documentation --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index d807f88..ce36c3d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,42 @@ # SCIM SCIM Service Provider + + +## Installation + +You can either Download the zip [here](https://lab.libreho.st/libre.sh/scim/rocketchat-scim/-/jobs/artifacts/main/browse?job=package) or build it yourself. + +Install `node 17.x` + +`npm install -g @rocket.chat/apps-cli@1.9.0` + +then use + +`rc-apps package` + +it will create a zip file under `./dist` + +Enable under Rocket.Chat administration > general > apps the developer mode. Choose as Apps Source Package Storage type FileSystem. +Use an absolute path that exists in your image - for example /app/uploads. + +Now you can upload the .zip file under administration > apps choose upload app and upload the .zip from ealier. + +You can scip the upload step and just use `rc-apps deploy`. + +**Warning: Be careful to not lock yourself out of your chat. I recommend setting up a extra admin account in Rocket.Chat.** + +After the Installation you can access the app under administration > apps > installed apps. + +For the app you need to setup a personal access token for the user that's gonna create channels and add the users. You should use an admin account for that, +but you can probably add a different user with the necessary permissions as well (not tested). +Under My Account > Personal Access Tokens you will need that token and the your user-id you get from that process. + +Now add the token and the user-id to the app and set up the scim-provider either from the [keycloak-scim project]( https://lab.libreho.st/libre.sh/scim/keycloak-scim ) or any other +IdP or SP that supports scim. + +If you set up everything correctly users and teams should be created as well as user added to existing roles in Rocket.Chat. + ## Download https://lab.libreho.st/libre.sh/scim/rocketchat-scim/-/jobs/artifacts/main/browse?job=package