• INTRODUCTION
• REQUIREMENTS
• Rocketchat instance Requirement
• the Modules
• INSTALLATION
• CONFIGURATION
• TROUBELSHOOTING
• FAQ
• MAINTAINERS

The Rocket.chat Module enables a drupal site to integrate Rocket.chat. It consists of several modules, see the Modules for assistance you can always ask on Drupalchat.me/Rocket.chat.Module

This module is designed for:

• Drupal 8
• Rocket.chat 1.0.0+

It is tested with:

• Drupal 8.8.5
• Rocket.chat 3.1.0
• php 7.4.4
• node v12.16.1

The main module does not require any other Drupal modules outside of this project,
aside from the following submodule(s):

• Rocket Chat Group integration(modules/rocket_chat_group). This submodule requires the group module as it extends the modules functionality.

This module does requirs you have access to a Rocket.chat of atleast the 1.0.0 release.

We only support Rocket chat instances that are behind a TLS reverse proxy.

• Rocket Chat(rocket_chat) the main Rocket.Chat integration module. allowing Rocket chat to be integrated with Drupal
• Rocket Chat API(rocket_chat_api) API module for Rocketchat. This allows for communication with a Rocket chat.
• Rocket Chat Api Test (rocket_chat_api_test) a Quick Test page that utilizes the Rocket chat API module to do API calls on the configured Rocket chat. This facilitates an easy interface to test api calls and see what the return.
• Rocket Chat Group integration(rocket_chat_group) Allows you to setup a group integration to have channels in the rocketchat for groups where users are automatically invited into the channel. (Made in conjuction with OpenSocial, OpenSocial Project).
• Rocket Chat Livechat Block(livechat) Allows controle over placeing the livechat widget on your site through th ebolocks interface.

• Install as you would normally install a contributed Drupal module. Visit https://www.drupal.org/node/1897420 for further information.Installation

Additionally, per module details are:

• Rocket chat Module:
  • if you have not done so already, setup Rocket chat. (out of scope for this readme, check out Rocket.chat for instructions on how to setup rocketchat.)
• Livechat Module:
  • install the livechat module and rocket_chat module.
  • Setup the rocket_chat module.
  • Go to [Structure][Block layout]. there you can place the livechat block using the "Place block" button. This works as a normal block we recommend you add it to a footer or alike for performance. Be aware we currently only suport the newer 2.0 version of the lifechat widget.
• Rocket Chat API Module:
  • This module enables you to utilize the Rocket chat API.
• API Test:
  • You can use this module to test the various aspects of the API without having to write all the code to do so. After enabling it its available on the /apitest path for rocketchat admins.
• Group integration:
  • When enabled your group should have A Channel field, this field will inform Rocket chat what naem to pick for the channel in Rocket chat.
  • The new Block. rocket Chat Group Channel controles where the iframe will be rendered to allow instant chat between members.

• Configure your rocketchat url in [drupal-url]/admin/config/rocket_chat , you will need to have the proper permissions!
• Several sub modules use blocks, check out the blocks ui for those.

Leave a detailed report of your issue in the issue queue and the maintainers will add it to the task list. I am also present in the Drupalchat.me/Rocket.chat.Module as @Sysosmaster.

• Q: I do not see anything happening A: Most likely you either forgot to place a block / render the block. Or you did not yet log in to your instance from the UI
• Q: Where can I go to ask some questions. A: You can always either create an issue, or ask a question on Drupalchat.me/Rocket.chat.Module

• Current:

  • Sysosmaster (Current maintainer of rocketchat module on d.o.).
  • idevit (Community Plumbing).

• Previous Authors (Hall of Fame):

  • Gabriel Engel (Creator Rocket.chat).
  • jelhouss (Initial Module Creator).

Last Updated, 15-April-2020.