Add guide for Rocket.Chat #585

d-sko · 2020-03-20T21:22:38Z

Hi, I've added a guide for Rocket.Chat.

closes #584

luto

Thank you very much for this guide! Despite the complexity, it is nice and easy to follow. I left a few comments to streamline it for less-experienced users.

luto · 2020-03-23T14:28:05Z

source/guide_rocketchat.rst

+
+::
+
+ [isabell@stardust ~]$ uberspace web backend set / --http --port 3000


There is an include for web backends, used like this. Can you please change this to match?

luto · 2020-03-23T15:19:31Z

source/guide_rocketchat.rst

+
+This is required because Rocket.Chat uses Meteor Oplog Tailing for performance improvements (see `the docs <https://rocket.chat/docs/installation/manual-installation/mongo-replicas/>`_ for further information). 
+
+Then tell supervisord to update and start the service:


This probably also needs supervisorctl reread to reload the config file.

luto · 2020-03-23T15:24:08Z

source/guide_rocketchat.rst

+
+ [program:rocket.chat]
+ command=node %(ENV_HOME)s/rocket.chat/main.js
+ environment=MONGO_URL="mongodb://<username>_rocketchat:<password>@localhost:27017/rocketchat?replicaSet=rs01&authSource=admin",MONGO_OPLOG_URL="mongodb://<username>_rocketchat:<password>@localhost:27017/local?replicaSet=rs01&authSource=admin",ROOT_URL="https://<username>.uber.space/",PORT=3000


Please split this into multiple lines (one per var), like in the synapse guide.

luto · 2020-03-23T15:25:57Z

source/guide_rocketchat.rst

+
+::
+
+ [isabell@stardust ~]$ mongo --username <username>_mongoroot --eval "printjson(rs.initiate())"


The mongodb guide suggest to use the uberspace username as <username>, so I think we can replace all <username>_mongoroot with ${USER}_mongoroot to make the guide easier to follow.

luto · 2020-03-23T15:26:44Z

source/guide_rocketchat.rst

+
+ [program:rocket.chat]
+ command=node %(ENV_HOME)s/rocket.chat/main.js
+ environment=MONGO_URL="mongodb://<username>_rocketchat:<password>@localhost:27017/rocketchat?replicaSet=rs01&authSource=admin",MONGO_OPLOG_URL="mongodb://<username>_rocketchat:<password>@localhost:27017/local?replicaSet=rs01&authSource=admin",ROOT_URL="https://<username>.uber.space/",PORT=3000


How about using %(ENV_USER)s_rocketchat here to reduce the number of things to manually replace?

luto · 2020-03-23T15:34:43Z

source/guide_rocketchat.rst

+ Using 'Node.js' version: '12'
+ [isabell@stardust ~]$
+
+We'll also need :lab:`MongoDB <guide_mongodb>`, so follow the MongoDB guide and come back when it's running.


How can we feature this more prominently? Maybe add it to the "familiar with the basic concepts of"-list? put it into a note box? List it as the first (or last) prerequisite?

luto · 2020-03-23T15:36:57Z

source/guide_rocketchat.rst

+
+::
+
+ [isabell@stardust ~]$ uberspace web domain list


Just like web backends, there is also an include for this.

d-sko · 2020-03-23T16:11:22Z

Thanks for the feedback! I'll change the guide accordingly.

the environment variable in the rocket.chat.ini is now split into multiple lines, one per variable

reread the config for mongo after updating

Moved the web backend configuration to the Configuration section and used the web-backend include

- forgot a shell prompt at the end of a listing - added missing colon - improved note for service ini

d-sko · 2020-03-23T18:35:40Z

Damn. I've fixed everything but upon testing I stumbled over RocketChat/Rocket.Chat#7465, this didn't happen on my other tests. I'll update the PR when I find a reasonable solution.

d-sko · 2020-03-24T04:47:35Z

I think I've found a solution that's not too bad 😅 . I've also fixed all points you mentioned.

<username> mention not required

luto · 2020-03-24T11:27:08Z

Would you like to try to submit your /tmp/ufs change as a pull request to rocketchat? If at all possible, we do not want to force users to edit the source code. That increases the complexity and tends to break on updates because, well, the code changes 😅

d-sko · 2020-03-24T11:57:52Z

Yes, fixing this in Rocket.Chat would be nicer of course. I just figured that a breaking change is unlikely here since the change is not in Rocket.Chat but the UploadFS package, which is deprecated (see https://github.com/jalik/meteor-jalik-ufs#uploadfs) and is unlikely to change much.

But regardless of that I'll have a look at the Rocket.Chat code... well, that escalated quickly 😁

off1ine · 2020-03-25T14:52:04Z

Hi and thanks a lot for this guide - just what I was looking for :)
Sorry for maybe breaking protocol, I'm still figuring out github. Is there a way you could add the content for the rocket.chat-user-setup.js file in line 193? I can see it in the raw code for the guide but it doesn't seem to show up for me (OS X FF, Chrome). Thanks a lot for your work!

d-sko · 2020-03-25T14:58:04Z

Hi, you can view the full guide in the netlify preview: https://deploy-preview-585--uberlab.netlify.com/guide_rocketchat.html. But here is the content for this file:

db.createUser(
   {
     user: "<username>_rocketchat",
     pwd: "<password>",
     roles: [
       {role:"dbOwner", db:"rocketchat"},
       {role:"readWrite", db:"local"},
       {role:"clusterMonitor", db:"admin"}
     ]
   }
)

d-sko · 2020-03-25T15:06:03Z

I've made a PR in Rocket.Chat, lets see what happens 😅

RocketChat/Rocket.Chat#17012

off1ine · 2020-03-26T09:36:35Z

Perfect, thank you! It worked and I'm up and running :)

luto · 2020-03-27T14:44:17Z

Thank you very much for all the work and the upstream PR! 🎉

luto · 2020-03-27T14:45:15Z

@d-sko I can't find your mail address. Please write us an email to hallo@uberspace.de for your reward :)

[rocket.chat] add guide for rocket.chat

8f28af4

luto self-assigned this Mar 23, 2020

luto requested changes Mar 23, 2020

View reviewed changes

luto reviewed Mar 23, 2020

View reviewed changes

d-sko added 8 commits March 23, 2020 17:30

[rocket.chat] split service environment variable

236884f

the environment variable in the rocket.chat.ini is now split into multiple lines, one per variable

[rocket.chat] use web-domain-list include

ea31ae6

[rocket.chat] add supervisorctl reread

9f89f00

reread the config for mongo after updating

[rocket.chat] add missing line breaks

010c838

[rocket.chat] move web backend to configuration

9f6efd2

Moved the web backend configuration to the Configuration section and used the web-backend include

[rocket.chat] use ${USER} in mongo commands

45f7178

[rocket.chat] add MongoDB to basic concepts list

83b445c

[rocket.chat] small cosmetic fixes

b72ed6a

- forgot a shell prompt at the end of a listing - added missing colon - improved note for service ini

d-sko added 2 commits March 24, 2020 05:42

[rocket.chat] add workaround for Rocket.Chat#7465

8dd8dae

[rocket.chat] fixed paths

a05d8af

[rocket.chat] fixed mongo notes

a4ab091

<username> mention not required

d-sko requested a review from luto March 24, 2020 11:12

luto merged commit b0dc42b into Uberspace:master Mar 27, 2020

d-sko deleted the rocketchat-guide branch March 31, 2020 08:07


		::

		[isabell@stardust ~]$ uberspace web backend set / --http --port 3000


		This is required because Rocket.Chat uses Meteor Oplog Tailing for performance improvements (see `the docs <https://rocket.chat/docs/installation/manual-installation/mongo-replicas/>`_ for further information).

		Then tell supervisord to update and start the service:


		::

		[isabell@stardust ~]$ mongo --username <username>_mongoroot --eval "printjson(rs.initiate())"

Add guide for Rocket.Chat #585

Add guide for Rocket.Chat #585

Uh oh!

Conversation

d-sko commented Mar 20, 2020

Uh oh!

luto left a comment

Choose a reason for hiding this comment

Uh oh!

luto Mar 23, 2020

Choose a reason for hiding this comment

Uh oh!

luto Mar 23, 2020

Choose a reason for hiding this comment

Uh oh!

luto Mar 23, 2020

Choose a reason for hiding this comment

Uh oh!

luto Mar 23, 2020

Choose a reason for hiding this comment

Uh oh!

luto Mar 23, 2020

Choose a reason for hiding this comment

Uh oh!

luto Mar 23, 2020

Choose a reason for hiding this comment

Uh oh!

luto Mar 23, 2020

Choose a reason for hiding this comment

Uh oh!

d-sko commented Mar 23, 2020

Uh oh!

d-sko commented Mar 23, 2020

Uh oh!

d-sko commented Mar 24, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

luto commented Mar 24, 2020

Uh oh!

d-sko commented Mar 24, 2020

Uh oh!

off1ine commented Mar 25, 2020

Uh oh!

d-sko commented Mar 25, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

d-sko commented Mar 25, 2020

Uh oh!

off1ine commented Mar 26, 2020

Uh oh!

luto commented Mar 27, 2020

Uh oh!

luto commented Mar 27, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

d-sko commented Mar 24, 2020 •

edited

Loading

d-sko commented Mar 25, 2020 •

edited

Loading