Skip to content

Commit dba6eee

Browse files
author
Lawri van Buël
committed
Critical Update:
 Issue #3127682 by interdruper, sysosmaster: rocket_chat 2.2.0 requires drupal/core 9.1.x-dev (Thank you interdruper for reporting this issue) Update: Updated README.md Added a CHANGELOG.md
1 parent 6712eae commit dba6eee

File tree

4 files changed

+128
-78
lines changed

4 files changed

+128
-78
lines changed

‎CHANGELOG.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Changelog
2+
Version:
3+
- 8.x-2.x
4+
- Fix for Issue [#3127682](https://www.drupal.org/project/rocket_chat/issues/3127682): rocket_chat 2.2.0 requires drupal/core 9.1.x-dev
5+
- 8.x-2.2
6+
- Public release of 2.x branch
7+
- Public release of the group module integration
8+
- Update to use the Lifechat 2.0 (Omnichannel) in the lifechat widgit.
9+
- 8.x-2.1 (Private Released)
10+
- Prototype OpenSocial Beta
11+
- 8.x-2.0 (Private Released)
12+
- Prototype Opensocial Alpha
13+
- 8.x-1.x
14+
- Tests (abanond on this branch, continue on branch 8.x-2.x)
15+
- 8.x-1.0
16+
- Initial Released version Drupal 8.
17+
18+
19+

‎README.md

+105-74
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,26 @@
1-
#_Rocket.chat_ Module for Drupal 8.x-2.2
1+
# _Rocket.chat_ Module for Drupal 8.x-2.3
2+
23

34
CONTENTS OF THIS FILE
45
---------------------
56

6-
* Introduction
7-
* Requirements
8-
* Rocketchat instance Requirement
9-
* (Sub=) Modules
10-
* Installation
11-
* Configuration
12-
* Troubleshooting
13-
* Maintainers
7+
* [INTRODUCTION](#introduction)
8+
* [REQUIREMENTS](#requirements)
9+
* [Rocketchat instance Requirement](#rocketchat-instance-requirement)
10+
* [the Modules](#the-modules)
11+
* [INSTALLATION](#installation)
12+
* [CONFIGURATION](#configuration)
13+
* [TROUBELSHOOTING](#troubleshooting)
14+
* [FAQ](#faq)
15+
* [MAINTAINERS](#maintainers)
16+
1417

1518
INTRODUCTION
1619
------------
1720

1821
The Rocket.chat Module enables a drupal site to integrate Rocket.chat.
19-
It consist of several modules, see [(Sub=) Modules](#-sub-modules)
20-
21-
Requirements
22-
------------
22+
It consists of several modules, see [the Modules](#the-modules)
23+
for assistance you can always ask on [Drupalchat.me/Rocket.chat.Module](https://drupalchat.me/channel/rocket.chat.module)
2324

2425
This module is designed for:
2526
- [Drupal 8](https://www.drupal.org/project/drupal)
@@ -31,87 +32,117 @@ It is tested with:
3132
- php 7.4.4
3233
- node v12.16.1
3334

35+
36+
REQUIREMENTS
37+
------------
38+
39+
The main module does not require any other Drupal modules outside of this
40+
project,
41+
aside from the following submodule(s):
42+
- `Rocket Chat Group integration`(modules/rocket_chat_group).
43+
This submodule requires the [group](https://www.drupal.org/project/group)
44+
module as it extends the modules functionality.
45+
46+
This module does requirs you have access to a [Rocket.chat](https://rocket.chat/)
47+
of atleast the 1.0.0 release.
48+
49+
3450
Rocketchat instance Requirement
3551
-------------------------------
3652

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

39-
(Sub-) Modules
40-
--------------
41-
- Rocket Chat(`rocket_chat`) the main Rocket.Chat integration module.
42-
allowing Rocket chat to be integrated with Drupal
43-
- Rocket Chat API(`rocket_chat_api`) API module for Rocketchat. This allows for
44-
communication with a Rocket chat.
45-
- Rocket Chat Api Test (`rocket_chat_api_test`) a Quick Test page that utilizes
46-
the Rocket chat API module to do API calls on the configured Rocket chat.
47-
This facilitates an easy interface to test api calls and see what the return.
48-
- Rocket Chat Group integration(`rocket_chat_group`) Allows you to setup a group
49-
integration to have channels in the rocketchat for groups where users are
50-
automatically invited into the channel. (Made in conjuction with
51-
[OpenSocial](https://www.getopensocial.com/),
52-
[OpenSocial Project](https://www.drupal.org/project/social)).
53-
- Rocket Chat Livechat Block(`livechat`) Allows controle over placeing the
54-
livechat widget on your site through th ebolocks interface.
55-
56-
Installation
55+
56+
the Modules
57+
-----------
58+
- Rocket Chat(`rocket_chat`) the main Rocket.Chat integration module.
59+
allowing Rocket chat to be integrated with Drupal
60+
- Rocket Chat API(`rocket_chat_api`) API module for Rocketchat. This allows for
61+
communication with a Rocket chat.
62+
- Rocket Chat Api Test (`rocket_chat_api_test`) a Quick Test page that utilizes
63+
the Rocket chat API module to do API calls on the configured Rocket chat.
64+
This facilitates an easy interface to test api calls and see what the return.
65+
- Rocket Chat Group integration(`rocket_chat_group`) Allows you to setup a group
66+
integration to have channels in the rocketchat for groups where users are
67+
automatically invited into the channel. (Made in conjuction with
68+
[OpenSocial](https://www.getopensocial.com/),
69+
[OpenSocial Project](https://www.drupal.org/project/social)).
70+
- Rocket Chat Livechat Block(`livechat`) Allows controle over placeing the
71+
livechat widget on your site through th ebolocks interface.
72+
73+
74+
INSTALLATION
5775
------------
5876

59-
- Rocket chat Module:
60-
- Install the module in your modules folder.
61-
- if you have not done so already, setup Rocket chat. (out of scope for this
62-
readme, check out [Rocket.chat](https://rocket.chat) for instructions on how
63-
to setup
64-
rocketchat.)
65-
- Livechat Module:
66-
- install the livechat module and rocket_chat module.
67-
- Setup the rocket_chat module.
68-
- Go to `[Structure][Block layout]`. there you can place the livechat block
69-
using the "Place block" button.
70-
This works as a normal block we recommend you add it to a footer or alike
71-
for performance.
72-
Be aware we currently only suport the newer 2.0 version of the lifechat widget.
73-
- Rocket Chat API Module:
74-
- This module enables you to utilize the Rocket chat API.
75-
- API Test:
76-
- You can use this module to test the various aspects of the API without
77-
having to write all the code to do so.
78-
After enabling it its available on the `/apitest` path for rocketchat
79-
admins.
80-
- Group integration:
81-
- When enabled your group should have A Channel field, this field will inform
82-
Rocket chat what naem to pick for the channel in Rocket chat.
83-
- The new Block. `rocket Chat Group Channel` controles where the iframe will
84-
be rendered to allow instant chat between members.
85-
86-
Configuration
77+
* Install as you would normally install a contributed Drupal module. Visit
78+
https://www.drupal.org/node/1897420 for further information.Installation
79+
80+
Additionally, per module details are:
81+
- Rocket chat Module:
82+
- if you have not done so already, setup Rocket chat. (out of scope for this
83+
readme, check out [Rocket.chat](https://rocket.chat) for instructions on how
84+
to setup rocketchat.)
85+
- Livechat Module:
86+
- install the livechat module and rocket_chat module.
87+
- Setup the rocket_chat module.
88+
- Go to `[Structure][Block layout]`. there you can place the livechat block
89+
using the "Place block" button.
90+
This works as a normal block we recommend you add it to a footer or alike
91+
for performance.
92+
Be aware we currently only suport the newer 2.0 version of the lifechat widget.
93+
- Rocket Chat API Module:
94+
- This module enables you to utilize the Rocket chat API.
95+
- API Test:
96+
- You can use this module to test the various aspects of the API without
97+
having to write all the code to do so.
98+
After enabling it its available on the `/apitest` path for rocketchat
99+
admins.
100+
- Group integration:
101+
- When enabled your group should have A Channel field, this field will inform
102+
Rocket chat what naem to pick for the channel in Rocket chat.
103+
- The new Block. `rocket Chat Group Channel` controles where the iframe will
104+
be rendered to allow instant chat between members.
105+
106+
107+
CONFIGURATION
87108
-------------
88109

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

92-
Troubleshooting
115+
TROUBLESHOOTING
93116
---------------
94-
117+
95118
Leave a detailed report of your issue in the
96119
[issue queue](https://www.drupal.org/project/issues/search/2649818) and the
97120
maintainers will add it to the task list.
98121
I am also present in the [Drupalchat.me/Rocket.chat.Module](https://drupalchat.me/channel/rocket.chat.module)
99122
as `@Sysosmaster`.
123+
124+
125+
FAQ
126+
---
127+
- Q: I do not see anything happening
128+
A: Most likely you either forgot to place a block / render the block.
129+
Or you did not yet log in to your instance from the UI
130+
- Q: Where can I go to ask some questions.
131+
A: You can always either create an issue, or ask a question on [Drupalchat.me/Rocket.chat.Module](https://drupalchat.me/channel/rocket.chat.module)
132+
100133

101-
Maintainers / Authors
102-
---------------------
134+
MAINTAINERS
135+
-----------
103136

104-
- [Sysosmaster](https://www.drupal.org/u/sysosmaster) (Current maintainer of
105-
rocketchat module on d.o.).
106-
107-
Previous Authors (Hall of Fame)
108-
----------------
109-
- [Gabriel Engel](https://www.drupal.org/u/gabriel-engel) (Creator Rocket.chat
110-
).
111-
- [idevit](https://www.drupal.org/u/idevit) (Community Plumbing).
112-
- [jelhouss](https://www.drupal.org/u/jelhouss) (Initial Module Creator).
137+
- Current:
138+
- [Sysosmaster](https://www.drupal.org/u/sysosmaster) (Current maintainer of
139+
rocketchat module on d.o.).
140+
- [idevit](https://www.drupal.org/u/idevit) (Community Plumbing).
141+
142+
- Previous Authors (Hall of Fame):
143+
- [Gabriel Engel](https://www.drupal.org/u/gabriel-engel) (Creator Rocket.chat).
144+
- [jelhouss](https://www.drupal.org/u/jelhouss) (Initial Module Creator).
113145

114-
This version marks the EoL for the 8.x-1.x branch, and the (only privatly released) 8.x-2.1 and 8.x-2.0.
115146

116-
Last Updated, 14-April-2020.
147+
Last Updated, 15-April-2020.
117148

‎composer.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
"require": {
2222
"ext-http": "*",
2323
"ext-json": "*",
24-
"php": "^7.2",
25-
"drupal/core": "9.1.x-dev"
24+
"php": "^7.3",
25+
"drupal/core": "^8.8 || ^9"
2626
},
2727
"require-dev": {
2828
"drupal/coder": "^8.3"

‎modules/rocket_chat_api/composer.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
],
1212
"require": {
1313
"guzzlehttp/guzzle": "^6.2",
14-
"php" : ">7.3",
15-
"drupal/core": ">=8"
14+
"php" : ">7.4",
15+
"drupal/core": "^8.8 || ^9"
1616
}
1717
}

0 commit comments

Comments
 (0)