Add Rocket.Chat installation instructors

2024-11-21 15:33:20 +01:00 · 2019-07-15 15:38:59 +02:00 · 2019-07-15 15:38:59 +02:00 · 7a1e5e8bcc
commit 7a1e5e8bcc
parent 22ab663a98
2 changed files with 112 additions and 4 deletions
--- a/Home.md
+++ b/Home.md
@ -23,13 +23,13 @@
 ### [Rocketchat Integration](https://github.com/EGroupware/egroupware/wiki/Rocketchat-Integration)
 * [Installation]
  - [[Admin Info]]
-  - [[Organisation Info]]
+  - [[Organization Info]]
  - [[Server Info]]
  - [[Register Server]]
 * [[Create OpenID Client]]
-* [[Add Custom Auth]]
+* [[Add Custom OAuth]]
 * [[Video Chat]]
-* [[Add None-EGroupware User]]
+* [[Add non-EGroupware User]]

 ### [Troubleshooting](https://github.com/EGroupware/egroupware/wiki/troubleshooting)
 * [Git clone Installation]()
--- a/Rocketchat-Integration.md
+++ b/Rocketchat-Integration.md
@ -2,8 +2,116 @@

 Rocketchat Integration
 =======
+## Installation
+Rocket.Chat needs to be configured and installed. The following steps show the configuration process in detail.

-_back to [Top](#Rocketchat installation)_
+> *After installation is finished, you may want to look into some administration details e.g. to configure non-EGroupware accounts or to switch video-chat (Jitsi) off for GDPR reasons.*
+
+|Installation steps
+|---------------------------------
+| [(1) Admin Info](#Admin-Info)- Configuring Admin username
+| [(2) Server Info](#Server-Info)- Providing Organizational Email, site name and language
+| [(3) Register Server](#Register-Server)- Selecting type of Server
+
+> *Following steps are necessary only for on-promise installations*
+
+|Only for on-promise installations
+|--------------------------------
+| [(4) Create OpenID Client](#Create-OpenID-Client)- Create OpenID-Identifier and secret via Admin->OpenID
+| [(5) Custom OAuth](#Custom-OAuth)- Configuring Custom OAuth on Rocketchat server
+
+
+#### Admin Info
+You need to provide a valid EGroupware username (recommended your user) to configure the first administrator of Rocket.Chat. That administrator can add additional EGroupware users as Rocket.Chat admins.
+Additionally you should insert a valid email address, which is used for the registration process of Rocket.Chat.
+
+<img src="https://www.egroupware.org/wp-content/uploads/2019/06/Admin-Info.png"/>
+
+#### Server Info
+Organization information is just some data which gets reported to Rocket.Chat via registration but its not used in EGroupware Rocket.Chat itself.
+
+<img src="https://www.egroupware.org/wp-content/uploads/2019/06/Organisation-Info.png"/>
+
+
+#### Register Server
+Here you can configure the site name is displayed in external Rocket.Chat clients. It's quite useful when using more than one Rocket.Chat.
+> *It makes sense to choose a meaningful name to identify the chat server!*
+
+Please choose a language which is common for the majority of your users. The language can be changed later on MyAccount for each user.
+
+<img src="https://www.egroupware.org/wp-content/uploads/2019/06/Server-Info.png"/>
+
+
+You need to decide, if you like to register your Rocket.Chat to get push notifications for smartphones. In that case all inserted information of the configuration gets sent to Rocket.Chat!
+
+> *EGroupware does not provide a push-service for notifications on smartphones, but you can use Rocket.Chat cloud services. Please take GDPR into account for your decision.*
+
+If you don't need push notifications, you can skip registration and click on keep standalone.
+
+<img src="https://www.egroupware.org/wp-content/uploads/2019/06/Register-Server-Push.png" />
+
+Rocket.Chat is successfully installed, you can now configure additional parameters e.g. switch video-chat off or add non-Egroupware user.
+
+<img src="https://www.egroupware.org/wp-content/uploads/2019/06/Setup-Done.png"/>
+
+#### Create OpenID Client
+You need to create a Client-Identifier and secret via ```Admin -> OpenID / OAuth2 server -> Clients```.
+
+Please insert a name for your Client-Identifier e.g. EGroupware Rocket.Chat and an Identifier - recommended Rocket.Chat
+
+This Client-Identifier needs to be inserted in the next step where you add the [custum OAuth](#Custom-OAth) server in EGroupware.
+
+The secret should be a random string (recommended minimum 12 chars), which is used and inserted in the [custom Oauth](#Custom-OAuth) server configuration together with the Client-Identifier in the next step!
+
+The Redirect URI needs to match your servername e.g. testbox.egroupware.org in my case. Using https is recommended, but only if secure connection is correctly configured!
+For Allowed grants you need to choose: Authorization Code, Refresh Token and Implicit.
+
+<img src="https://www.egroupware.org/wp-content/uploads/2019/07/OpenID.png"/>
+
+#### Custom OAuth
+Please go back to Rocket.Chat into `Administration -> OAuth` and click on *Add Custom OAuth*. Give it a name eg. EGroupware.
+
+<img src="https://www.egroupware.org/wp-content/uploads/2019/07/OAuth.png"/>
+
+At the top of the page the [custom OAuth](#Custom-OAuth) server EGroupware is added and you need to insert several values. Please check all red marked rows where you need to insert your data. These listed values in the screenshot are just a few important values, but all need to be inserted correctly!
+
+URL: http(s)://servername/egroupware/openid/endpoint.php Servername needs to be matched with your servername or IP-address.
+
+<img src="https://www.egroupware.org/wp-content/uploads/2019/07/OAuth2.png"/>
+
+Id needs to be the Client-Identifier you previously configured for the OpenID Client! Similar is valid for the secret.
+
+> *If you can't remember the secret you chose previously, you may re-generate and save the secret in the EGroupware OpenID client.*
+
+See also previous tab [Create OpenID client](#Create-OpenID-Client)
+
+<img src="https://www.egroupware.org/wp-content/uploads/2019/07/OAuth3.png"/>
+
+Please check also our technical documentation page on Github: https://github.com/EGroupware/openid
+
+### Video Chat
+You need to decide whether to allow video-chats and screen-sharing or not for GDPR reasons.
+
+> *EGroupware does not provide a Jitsi-server for video-chats, therefore the Jitsi-server configured by default is a public server from the open source project Jitsi Meet. Please take GDPR into account for your decision, we have not found neither any declaration of data protection on their website nor where the servers are located.*
+
+<img src="https://www.egroupware.org/wp-content/uploads/2019/06/Video-Konferenz.png"/>
+
+### Add non-EGroupware User
+If you would like to allow non-EGroupware users to take part in your Rocket.Chat you can enable in *Account Settings* to show the *Default Login Form*.
+
+By default we only show: EGroupware users click here and not username and password fields for external users! EGroupware users should always use the provided click here link!
+
+<img src="https://www.egroupware.org/wp-content/uploads/2019/06/Account-Settings.png"/>
+
+Next step is to create the non-users manually in administration users. You need to specify username and password. depending on the settings to allow password change or not, please allow or deny that the user can change the password which is switched off by default.
+> *the password change in rocket.chat will not change the user password of egroupware!*
+
+Finally, an email will be sent containing the login details for Rocket.Chat to the configured email address during the setup.
+
+<img src="https://www.egroupware.org/wp-content/uploads/2019/06/Create-account.png"/>
+
+
+_back to [Top](#Rocketchat-installation)_

 * * *