Skip to content

coderockrdev/isa-xingu-rocket-chat

Repository files navigation

#Rocket.chat Module for Drupal 8.

CONTENTS OF THIS FILE

  • Introduction
  • Requirements
  • Recommendations
  • Installation
  • Configuration
  • Troubleshooting
  • Maintainers

INTRODUCTION

The Rocket.chat Module enables a drupal site to integrate Rocket.chat.
It consist of several modules:

  • Rocket chat: The base module that holds the configuration.
  • Live chat: the Live chat module contains a block you can place to have the rocketchat livechat widget on a page you can control as a block.

Requirements

This module is designed for:

It is tested with:

  • Drupal 8.3.7
  • Rocket.chat 0.58.0

Recommendations

We strongly recommend you run your Drupal and your Rocket.chat behind a TLS proxy or webserver with TLS capabilities.
When using this module beware of HTTPS<->HTTP crossovers, they often just do not work and for this reason we recommend you turn both services under TLS.
In order to use the livechat functionality you need to enable livechat on your rocket.chat instance, or you will not see anything.

Installation

  • Rocket chat Module:
    • Install the module in your modules folder.
    • 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.
  • 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.

Configuration

  • Configure your rocketchat url in [drupal-url]/admin/config/rocket_chat , you will need to have the proper permissions!

Troubleshooting

Leave a detailed report of your issue in the issue queue and the maintainers will add it to the task list.

Maintainers

Last Updated, 28-August-2017.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •