Difference between revisions of "Rocket Chat:Contrib"

From SME Server
Jump to navigationJump to search
 
(66 intermediate revisions by 3 users not shown)
Line 1: Line 1:
'''[[Rocket_Chat#smeserver-rocketchat_contrib|Contrib]]''': [mailto:jcrisp@safeandsound.co.uk[[User:ReetP|John Crisp]]]
+
'''[[Rocket_Chat#smeserver-rocketchat_contrib|Contrib]]''': [mailto:jcrisp@safeandsound.co.uk][[User:ReetP|John Crisp]]
{{Note box|Please note that there is also a howto on installing Rocket.Chat manually [[Rocket_Chat|'''here''']]}}
+
{{Note box|Please note that there is also a howto on manually installing Rocket.Chat [[Rocket_Chat|'''here.''' That manual installing is largely obsolete.]]}}
 +
 
 +
Later versions will need my newer smeserver-rocketchat-0.4.x contrib which uses docker.
 +
 
 
==smeserver-rocketchat contrib==
 
==smeserver-rocketchat contrib==
 
{{WIP box}}
 
{{WIP box}}
This contrib aims to reduce some of the setup for rocketchat and add some flexibility with settings
 
  
{{Note box | This will ONLY work up to Rocket Chat version 0.39 as they changed the required node version after that. I am working on an update to the contrib - see the end for notes}}
+
===Version===
 +
{{ #smeversion: smeserver-rocketchat }}
 +
 
 +
 
 +
==Required repos==
  
 
Add repos:
 
Add repos:
  
 
* [[epel]]
 
* [[epel]]
* [[Centos-sclo-rh]]
+
* [[mongoDB]]
 +
* [[Docker]]
 
* [[User:ReetP|reetp]]  
 
* [[User:ReetP|reetp]]  
  
yum install rh-python34-python rh-mongodb26-mongodb rh-mongodb26-mongodb-server nodejs010 GraphicsMagick --enablerepo=centos-sclo-rh,epel
+
===Installation===
  
scl enable nodejs010 bash
+
There is now a smeserver-rocketchat contrib to install Rocket.Chat with docker.
npm install -g inherits
 
npm install -g n
 
n 0.10.40
 
exit
 
  
{{Note box | Please be careful to only install JUST the required packages in my repo. There are various testing packages in there that will BREAK YOUR SYSTEM ! }}
+
Install Mongo DB natively as per the wiki page https://wiki.koozali.org/MongoDB
  
You should now be able to install the rocketchat bundle with:
+
Currently it is suggested to use Mongo 4.4
  
yum --enablerepo=reetp install rocketchat
+
Mongo 5+ requires additional instructions in the CPU that older CPUs may not have. See teh wiki page for more.
  
This may take a while on first install as it installs the npm modules for the first time.
+
Do not go further than initiating the replicaset. Users are not required.
  
Now you should be able to install the rocketchat contrib:
+
Next install smeserver-docker following the wiki page https://wiki.koozali.org/Docker
  
yum --enablerepo=reetp install smeserver-rocketchat
 
  
db configuration setprop rocketchat status enabled
 
  
signal-event post-upgrade;signal-event reboot
+
Settings
  
DB settings
+
config set rocketchat service TCPPort 3000 mailPort 25 mailURL localhost access private status enabled SSLProxy yes Version 5.4.9 rootURL chat.domain.com
  
rocketchat=service
 
    TCPPort=3000
 
    access=public
 
    mailPort=25
 
    mailURL=localhost
 
    status=enabled
 
  
  rh-mongodb26-mongod=service
+
  signal-event post-upgrade;signal-event reboot
    TCPPort=27017
 
    access=private
 
    mongoURL=localhost
 
    status=enabled
 
  
BEFORE we login for the first time we need to set up mail settings correctly:
 
  
From bash:
+
System ➔ startup
 +
+----------------------------------------------------+
 +
|                  SERVER RUNNING                    |
 +
+----------------------------------------------------+
 +
|                                                    |
 +
|      Version: 0.xx.x                              |
 +
|  Process Port: 3000                                |
 +
|      Site URL: <nowiki>http://rocketchat.local.net:3000</nowiki>    |
 +
|        OpLog: Disabled                            |
 +
|                                                    |
 +
+----------------------------------------------------+
  
mongo rocketchat --eval 'db.rocketchat_settings.update({"_id" : "SMTP_Host"}, {$set: {"value":"localhost"}});'
+
You should now be able to connect to your Rocket.Chat instance
mongo rocketchat --eval 'db.rocketchat_settings.update({"_id" : "From_Email"}, {$set: {"value":"admin@yourdomain.com"}});'
 
  
We can check the individual values set like this:
+
http://rocketchat.local.net:3000
  
mongo rocketchat --eval 'db.rocketchat_settings.find({"_id":"From_Email"}, {_id:0, value:1}).shellPrint();'
+
===Registering a new account===
mongo rocketchat --eval 'db.rocketchat_settings.find({"_id":"SMTP_Host"}, {_id:0, value: 1}).shellPrint();'
 
  
All values per _id:
+
Because the SME mail server is fussy you may find it easier to force some settings in the Rocket.Chat DB before trying to register:
mongo rocketchat --eval 'db.rocketchat_settings.find({"_id" : "SMTP_Host"}).shellPrint();'
 
mongo rocketchat --eval 'db.rocketchat_settings.find({"_id" : "From_Email"}).shellPrint();'
 
  
 +
You can set your SMTP host as localhost or mail.yourdomain.com
  
Now restart rocketchat to reread the DB settings:
+
mongo
 +
use rocketchat
 +
db.rocketchat_settings.update({"_id" : "SMTP_Host"}, {$set: {"value":"mail.yourdomain.com"}})
 +
db.rocketchat_settings.update({"_id": "From_Email"}, {$set: {"value":"admin@yourdomain.com"}})
 +
      exit<
  
service rocketchat restart
 
  
Login at http://yourdomain:3000
+
===Reverse proxy===
  
It will first get you to create an admin user.
+
Now we need to setup our subdomain for the reverse proxy
  
If you have an issue with no email sent/received then login using the email address and password you just set
+
db domains set chat.mycompany.local domain Description RocketChat Nameservers internet \
 +
TemplatePath ProxyPassVirtualRocketchat ProxyPassTarget http://localhost:3000/
  
===Updates===
+
It should look like this:
 +
chat.mycompany.local=domain
 +
  Nameservers=internet (can be localhost)
 +
  ProxyPassTarget=http://127.0.0.1:3000/
 +
  TemplatePath=ProxyPassVirtualRocketchat
 +
  letsencryptSSLcert=enabled (with letsencrypt support)
  
If there is an update to Rocket.Chat I will add to my repo. You should just be able to run:
+
We need to set Rocket.Chat to listen on localhost now:
  
  yum --enablerepo=reetp install rocketchat
+
  config setprop rocketchat rootURL chat.mycompany.domain SSLProxy yes
 +
signal-event smeserver-rocketchat-update
  
You can also update the smeserver-rocketchat contrib in the same way
+
Now start the docker container (always run compose from the docker directory)
  
  yum --enablerepo=reetp install smeserver-rocketchat
+
  cd /home/e-smith/files/docker/configs
 +
docker-compose up -d rocketchat
 +
docker logs -f rocketchat
  
===SSL===
+
db accounts setprop Primary SSL enabled
 +
signal-event ibay-modify Primary
  
{{Note box | This is still experimental and there may be issues with SSL only for the Primary iBay and Letsencrypt. You will need a minimum version of smeserver-rocketchat-0.1-5 }}
 
  
{{Note box | I've realised I need to re-hack the web templates for this but still trying to work it out - please ask in the forums and I can give you some tips to get it working}}
+
==Bugs==
  
It is recommended to add Letsencrypt support as detailed below.
+
Please raise bugs under the SME-Contribs section in {{BugzillaFileBug|product=|component=|title=bugzilla}}and select the smeserver-rocketchat component or use
 +
{{BugzillaFileBug|product=SME%20Contribs|component=smeserver-rocketchat |title=this link}}.
  
We need some extra settings to enable SSL with ProxyPass.
 
  
First install proxy pass rpm:
+
{{#bugzilla:columns=id,product,version,status,summary |sort=id |order=desc |disablecache=1 |component=smeserver-rocketchat |noresultsmessage="No open bugs found."}}
  
Add the FWS repo
 
  
* [[Fws]]
+
==Mongo DB examples==
  
yum --enablerepo=fws install mod_proxy_wstunnel
+
===Usage===
  
Regenerate httpd.conf
+
Example using mongo itself:
  
  signal-event remoteaccess-update
+
  mongo
  
Now we need to setup our subdomain
+
use rocketchat
  
db domains set chat.mycompany.local domain Description RocketChat Nameservers internet \
+
Show all collections in DB
  TemplatePath ProxyPassVirtualRocketchat ProxyPassTarget http://localhost:3000/
+
  show collections
  
It should look like this:
+
Show all entries in a collection
 +
db.rocketchat_avatars.chunks.find()
  
  chat.mycompany.local=domain
+
  db.rocketchat_settings.find({"_id" : "SMTP_Host"})
    Nameservers=internet
+
db.rocketchat_settings.find({"_id" : "From_Email"})
    ProxyPassTarget=http://127.0.0.1:3000/
 
    TemplatePath=ProxyPassVirtualRocketchat
 
  
 +
db.getCollection("rocketchat_settings").find({"name":"Joe Blogs"})
  
We need to set Rocket.Chat to listen on localhost now:
+
db.getCollection("rocketchat_settings").find({"_id":{$regex:"^LDAP"}})
 +
db.getCollection("rocketchat_settings").find({"value": {$regex: 'hostname', $options: 'i'}});
  
  config setprop rocketchat rootURL localhost
+
  db.rocketchat_settings.findOne({_id : "From_Email"}, {_id:0, value: 1})
  signal-event remoteaccess-update
+
  db.rocketchat_settings.findOne({_id : "SMTP_Host"}, {_id:0, value: 1})
service rocketchat restart
 
  
If you can now successfully get to Rocketchat on your subdomain https://chat.mycompany.local you can disable default access on port 3000:
+
db.rocketchat_settings.update({"_id":"From_Email"}, {$set: {"value":"admin@yourdomain.com"}})
 +
db.rocketchat_settings.update({"_id":"SMTP_Host"}, {$set: {"value":"mail.yourdomain.com"}})
  
config setprop rocketchat access private
 
signal-event remoteaccess-update
 
  
===Letsencrypt support===
+
Remove all entries in a collection (CAREFUL!!!!!!)
 +
db.rocketchat_avatars.chunks.remove({})
  
{{Note box | 26 Aug 2016 - This should now work for a subdomain}}
+
Help
 +
help
  
You can add letsencrypt should you wish - please see https://wiki.contribs.org/Letsencrypt
+
Some more mongo commands for reference
  
You will need to add the domain key as follows, and add your letsencrypt certificates as per the wiki page:
+
https://github.com/RocketChat/Rocket.Chat/issues/15880#issuecomment-570070433
  
  db domains setprop chat.mycompany.local letsencryptSSLcert enabled
+
Directly check a specific user ID from bash:
 +
  mongo rocketchat --eval "db.users.find({'username':'usernamehere'}).forEach( function(u) { print(u._id + \" ; \" + u.username); } )"
  
Note that smeserver-rocketchat adds redirect on port 80 for the letsencrypt directory .well-known/acme-challenge
+
Log into rocketchat database:
 +
mongo rocketchat
  
You should be able to reach:
+
Check out all the user IDs in the database:  
 +
db.users.find().forEach( function(u) { print(u._id + ";" + u.username); } )
  
  http://chat.mycompany.local/.well-known/acme-challenge/
+
Or just a specific user's ID:
 +
  db.users.find({'username':'usernamehere'}).forEach( function(u) { print(u._id + \" ; \" + u.username); } )
  
This should redirect to:
+
Replace specific user ID's password in the database:
 +
db.users.update( {'_id': 'useridhere'}, {$set: {'services.password.bcrypt': 'bcryptedpasswordhere'}}, {multi:true} )
  
https://chat.mycompany.local/.well-known/acme-challenge/
+
My only issue with above (only time I needed it for recovery purposes), was that I didn't know which tool to use to generate a bcrypted password. So in the hurry I copied the hash from one account I already knew (my own). If someone knows a good command for creating one directly in bash, I assume it would do.
  
Anything else going to chat.mycompany.local should get to Rocket.Chat
+
There are bcrypt password generators online, and various libraries you can use
  
===Errors===
+
For listing out any passwords in the database I used:
  
You may get an error on install of the rocketchat rpm as follows:
+
  db.users.find().forEach( function(u) { print(u.services.password.bcrypt + " ; " + u.username); } )
  
npm WARN deprecated minimatch@2.0.10: Please update to minimatch 3.0.2 or higher to avoid a RegExp DoS issue
+
If you have deactivated users it may fail so use this for individual accounts.
  
This is due to the installed version of npm/node from SCL. Rocket.Chat should till work
+
However, you can get it for an individual user with:
  
==Mongo DB examples==
+
db.users.find({'username':'SomeUserName'}).forEach( function(u) { print(u.services.password.bcrypt + " ; " + u.username); } )
  
Example using mongo itself:
+
Set a user config item:
  
  mongo
+
  db.users.update( {'username': 'SomeUserName'}, {$set: {'settings.preferences.showMessageInMainThread': 'true'}} )
  
use rocketchat
+
Find a single user:
  
  db.rocketchat_settings.find({"_id" : "SMTP_Host"})
+
  db.getCollection('users').find( {'username':'SomeUserName'} )
db.rocketchat_settings.find({"_id" : "From_Email"})
 
  
db.rocketchat_settings.findOne({_id : "From_Email"}, {_id:0, value: 1})
+
Get limited information:
db.rocketchat_settings.findOne({_id : "SMTP_Host"}, {_id:0, value: 1})
 
  
 +
db.getCollection('users').find({}, {"username":1, "settings.preferences.showMessageInMainThread":1})
  
db.rocketchat_settings.update({"_id" : "From_Email"}, {$set: {"value":"admin@reetspetit.info"}})
+
Reset 2FA nonsense:
db.rocketchat_settings.update({"_id" : "SMTP_Host"}, {$set: {"value":"mail.reetspetit.info"}})
 
  
==Rocketchat 0.40+==
+
db.users.update({'username': 'SomeUserName'}, {$unset: {'services.totp': 1}});
 +
db.users.update({'username': 'SomeUserName'}, {$unset: {'services.email2fa': 1}});
  
From Rocketchat 0.40 onwards you require a higher version of node than the one in the EPEL repos.
+
===Database Backup===
  
===Setup===
+
You can dump the tables to a directory of your choice:
  
Add the following repos:
+
mongodump --dumpDbUsersAndRoles -d rocketchat -o /root/rocketchatmongo
  
/sbin/e-smith/db yum_repositories set epel repository \
+
===Database Restore===
Name 'Epel - EL6' \
 
BaseURL 'http://download.fedoraproject.org/pub/epel/6/$basearch' \
 
MirrorList 'http://mirrors.fedoraproject.org/mirrorlist?repo=epel-6&arch=$basearch' \
 
EnableGroups no \
 
GPGCheck yes \
 
GPGKey http://dl.fedoraproject.org/pub/epel/RPM-GPG-KEY-EPEL \
 
Exclude perl-Razor-Agent \
 
Visible no \
 
status disabled
 
  
/sbin/e-smith/db yum_repositories set reetp repository \
+
You can restore you database as follows:
BaseURL http://www.reetspetit.com/smeserver/\$releasever \
 
EnableGroups no \
 
GPGCheck no \
 
Name "ReetP Repo" \
 
GPGKey http://www.reetspetit.com/RPM-GPG-KEY \
 
Visible yes status disabled
 
  
  /sbin/e-smith/db yum_repositories set centos-sclo-rh \
+
  mongorestore --restoreDbUsersAndRoles -d rocketchat -dir /root/rocketchatmongo/rocketchat --quiet
repository Name 'Centos-RH Software collections' \
 
  BaseURL 'http://mirror.centos.org/centos/$releasever/sclo/$basearch/rh/' \
 
EnableGroups no Visible yes status disabled
 
  
/sbin/e-smith/db yum_repositories set nodejs \
+
===Database Fix tables===
repository Name 'Node JS 4' \
 
BaseURL https://rpm.nodesource.com/pub_4.x/el/6/x86_64 \
 
EnableGroups no GPGCheck no Visible yes status disabled
 
  
signal-event yum-modify
+
To remove user data file links a variation on this link
 +
https://github.com/RocketChat/feature-requests/issues/718
  
  yum --enablerepo=nodejs install nodejs nodejs-devel
+
  mongo
 +
use rocketchat
 +
db.rocketchat_user_data_files.remove( { } )
 +
db.runCommand({ compact: 'rocketchat_user_data_files', force: true });
 +
quit;
  
yum --enablerepo=centos-sclo-rh,epel install scl-utils rh-python34-python rh-mongodb26-mongodb rh-mongodb26-mongodb-server \
+
==Node usage==
GraphicsMagick
 
  
You should be able to install the smeserver-rocketchat RPM now
+
* This should go to a new Node page for reference
  
yum --enablerepo=reetp install smeserver-rocketchat
+
Use n, an extremely simple Node version manager that can be installed via npm (See http://stackoverflow.com/questions/7718313/how-to-change-to-an-older-version-of-node-js)
  
config set rocketchat service TCPPort 3000 mailPort 25 mailURL localhost access public status enabled
+
Say you want Node.js v0.10.x to build Atom.
config set rh-mongodb26-mongod service TCPPort 27017 mongoURL localhost access private status enabled
 
  
  signal-event post-upgrade;signal-event reboot
+
  npm install -g n  # Install n globally
 +
n 0.10.33          # Install and use v0.10.33 local only
  
 +
Usage:
 +
n                            # Output versions installed
 +
n latest                    # Install or activate the latest node release
 +
n stable                    # Install or activate the latest stable node release
 +
n <version>                  # Install node <version>
 +
n use <version> [args ...]  # Execute node <version> with [args ...]
 +
n bin <version>              # Output bin path for <version>
 +
n rm <version ...>          # Remove the given version(s)
 +
n --latest                  # Output the latest node version available
 +
n --stable                  # Output the latest stable node version available
 +
n ls                        # Output the versions of node available
  
===RocketChat run checks===
 
  
Check /var/log/rocketchat.log
+
==NPM Usage==
  
System ➔ startup
+
To update your version of npm run the following
+--------------------------------------------------+
 
|                  SERVER RUNNING                  |
 
+--------------------------------------------------+
 
|                                                  |
 
|      Version: 0.xx.x                            |
 
|  Process Port: 3000                              |
 
|      Site URL: http://rocketchat.local.net:3000  |
 
|        OpLog: Disabled                          |
 
|                                                  |
 
+--------------------------------------------------+
 
  
If you have issues make sure you stop the rocket chat service
+
npm install -g npm
  
service rocketchat stop
+
Or for a specific version:
  
Check your node versions:
+
npm install -g npm@3.10.9
  
[root@test Rocket.Chat]# node -v
+
==DB settings==
v4.5.0
 
[root@test Rocket.Chat]# npm -v
 
3.10.8
 
  
Modify with
+
Typical standard setup:
 
+
rocketchat=service
n 0.4.6
+
    TCPPort=3000
 
+
    access=public
Try running main.js
+
    mailPort=25
/opt/Rocket.Chat
+
    mailURL=localhost
node main.js
+
    status=enabled
  
 +
Typical proxy subdomain setup:
 +
rocketchat=service
 +
    SSLProxy=yes
 +
    TCPPort=3000
 +
    access=private
 +
    mailPort=25
 +
    mailURL=localhost
 +
    rootURL=chat.mydomain.co.uk
 +
    status=enabled
  
  
  
===Manual config of templates===
+
==Koozali SME v10==
expand-template /etc/rc.d/init.d/rocketchat
 
expand-template /etc/profile.d/scls-rh-mongodb26.sh
 
expand-template /etc/profile.d/scls-rh-python34.sh
 
expand-template /etc/profile.d/scls-rh-java-common.sh
 
expand-template /etc/opt/rh/rh-mongodb26/mongod.conf
 
  
/etc/rc.d/init.d/rocketchat start
+
I am starting to look at running this under docker on v10
/etc/rc.d/init.d/rh-mongodb26-mongos start
 
  
 +
Some quick notes.
  
 +
You will need
  
===Proxy Pass===
+
Docker
 +
https://wiki.contribs.org/Docker
  
The contrib will sort out the templates. You just need some settings as follows:
+
Docker Compose  (because it makes it easier to template)
 +
https://github.com/docker/compose/releases
  
[root@test e-smith]# db domains show
+
Docker environment settings to disable 2FA
chat.reetspetit.info=domain
 
    Description=RocketChat
 
    Nameservers=internet
 
    ProxyPassTarget=http://127.0.0.1:3000/
 
    TemplatePath=ProxyPassVirtualRocketchat
 
    letsencryptSSLcert=enabled
 
  
 +
  - OVERWRITE_SETTING_Accounts_TwoFactorAuthentication_Enforce_Password_Fallback=false
 +
  - OVERWRITE_SETTING_Accounts_TwoFactorAuthentication_Enabled=false
  
===SSL===
+
Mongo (I prefer to run a full instance rather than a docker one)
{{Note box|This is still experimental and there may be issues with SSL only for the Primary iBay and Letsencrypt. You will need a minimum version of smeserver-rocketchat-0.1-5 }}
+
https://wiki.contribs.org/MongoDB
  
 +
Make sure you add replicaset support in Mongo and set it up:
  
It is recommended to add Letsencrypt support as detailed below.
+
mongo --eval "printjson(rs.initiate())"
  
We need some extra settings to enable SSL with ProxyPass.
 
  
First install proxy pass rpm:
+
I'll add more later, and try and make a full contrib in due course
yum --enablerepo=fws install mod_proxy_wstunnel
 
  
Regenerate httpd.conf
+
FAQ
signal-event remoteaccess-update
 
  
Now we need to setup our subdomain
+
https://handbook.rocket.chat/company/tools/rocket.chat
  
db domains set chat.mycompany.local domain Description RocketChat Nameservers internet \
+
==Bugs==
TemplatePath ProxyPassVirtualRocketchat ProxyPassTarget http://localhost:3000/
 
 
 
It should look like this:
 
chat.mycompany.local=domain
 
  Nameservers=internet
 
  ProxyPassTarget=http://127.0.0.1:3000/
 
  TemplatePath=ProxyPassVirtualRocketchat
 
 
 
We need to set Rocket.Chat to listen on localhost now:
 
  
config setprop rocketchat rootURL localhost
+
Please raise bugs under the SME-Contribs section in {{BugzillaFileBug|product=|component=|title=bugzilla}}and select the smeserver-rocketchat component or use
  signal-event remoteaccess-update
+
  {{BugzillaFileBug|product=SME%20Contribs|component=smeserver-rocketchat |title=this link}}.
service rocketchat restart
 
  
If you can now successfully get to Rocketchat on your subdomain https://chat.mycompany.local you can disable default access on port 3000:
 
  
config setprop rocketchat access private
+
{{#bugzilla:columns=id,product,version,status,summary |sort=id |order=desc |disablecache=1 |component=smeserver-rocketchat |noresultsmessage="No open bugs found."}}
signal-event remoteaccess-update
 

Latest revision as of 16:35, 16 August 2024

Contrib: [1]John Crisp

Important.png Note:
Please note that there is also a howto on manually installing Rocket.Chat here. That manual installing is largely obsolete.


Later versions will need my newer smeserver-rocketchat-0.4.x contrib which uses docker.

smeserver-rocketchat contrib

Warning.png Work in Progress:
This page is a Work in Progress. The contents off this page may be in flux, please have a look at this page history the to see list of changes.


Version

Alpha 10:
smeserver-rocketchat
The latest version of smeserver-rocketchat is available in the SME repository, click on the version number(s) for more information.



Required repos

Add repos:

Installation

There is now a smeserver-rocketchat contrib to install Rocket.Chat with docker.

Install Mongo DB natively as per the wiki page https://wiki.koozali.org/MongoDB

Currently it is suggested to use Mongo 4.4

Mongo 5+ requires additional instructions in the CPU that older CPUs may not have. See teh wiki page for more.

Do not go further than initiating the replicaset. Users are not required.

Next install smeserver-docker following the wiki page https://wiki.koozali.org/Docker


Settings

config set rocketchat service TCPPort 3000 mailPort 25 mailURL localhost access private status enabled SSLProxy yes Version 5.4.9 rootURL chat.domain.com


signal-event post-upgrade;signal-event reboot


System ➔ startup
+----------------------------------------------------+
|                  SERVER RUNNING                    |
+----------------------------------------------------+
|                                                    |
|       Version: 0.xx.x                              |
|  Process Port: 3000                                |
|      Site URL: http://rocketchat.local.net:3000    |
|         OpLog: Disabled                            |
|                                                    |
+----------------------------------------------------+

You should now be able to connect to your Rocket.Chat instance

http://rocketchat.local.net:3000

Registering a new account

Because the SME mail server is fussy you may find it easier to force some settings in the Rocket.Chat DB before trying to register:

You can set your SMTP host as localhost or mail.yourdomain.com

mongo
use rocketchat
db.rocketchat_settings.update({"_id" : "SMTP_Host"}, {$set: {"value":"mail.yourdomain.com"}})
db.rocketchat_settings.update({"_id": "From_Email"}, {$set: {"value":"admin@yourdomain.com"}})
      exit<


Reverse proxy

Now we need to setup our subdomain for the reverse proxy

db domains set chat.mycompany.local domain Description RocketChat Nameservers internet \
TemplatePath ProxyPassVirtualRocketchat ProxyPassTarget http://localhost:3000/

It should look like this:

chat.mycompany.local=domain
  Nameservers=internet (can be localhost)
  ProxyPassTarget=http://127.0.0.1:3000/
  TemplatePath=ProxyPassVirtualRocketchat
  letsencryptSSLcert=enabled (with letsencrypt support)

We need to set Rocket.Chat to listen on localhost now:

config setprop rocketchat rootURL chat.mycompany.domain SSLProxy yes
signal-event smeserver-rocketchat-update

Now start the docker container (always run compose from the docker directory)

cd /home/e-smith/files/docker/configs
docker-compose up -d rocketchat
docker logs -f rocketchat
db accounts setprop Primary SSL enabled
signal-event ibay-modify Primary


Bugs

Please raise bugs under the SME-Contribs section in bugzilla and select the smeserver-rocketchat component or use

this link .


IDProductVersionStatusSummary
12390SME Contribs10.0RESOLVEDFirst import smeserver-rocketchat to SME 10 [smeserver-rocketchat] v0.4-1


Mongo DB examples

Usage

Example using mongo itself:

mongo
use rocketchat

Show all collections in DB

show collections

Show all entries in a collection

db.rocketchat_avatars.chunks.find()
db.rocketchat_settings.find({"_id" : "SMTP_Host"})
db.rocketchat_settings.find({"_id" : "From_Email"})
db.getCollection("rocketchat_settings").find({"name":"Joe Blogs"})
db.getCollection("rocketchat_settings").find({"_id":{$regex:"^LDAP"}})
db.getCollection("rocketchat_settings").find({"value": {$regex: 'hostname', $options: 'i'}});
db.rocketchat_settings.findOne({_id : "From_Email"}, {_id:0, value: 1})
db.rocketchat_settings.findOne({_id : "SMTP_Host"}, {_id:0, value: 1})
db.rocketchat_settings.update({"_id":"From_Email"}, {$set: {"value":"admin@yourdomain.com"}})
db.rocketchat_settings.update({"_id":"SMTP_Host"}, {$set: {"value":"mail.yourdomain.com"}})


Remove all entries in a collection (CAREFUL!!!!!!)

db.rocketchat_avatars.chunks.remove({})

Help

help

Some more mongo commands for reference

https://github.com/RocketChat/Rocket.Chat/issues/15880#issuecomment-570070433

Directly check a specific user ID from bash:

mongo rocketchat --eval "db.users.find({'username':'usernamehere'}).forEach( function(u) { print(u._id + \" ; \" + u.username); } )"

Log into rocketchat database:

mongo rocketchat

Check out all the user IDs in the database:

db.users.find().forEach( function(u) { print(u._id + ";" + u.username); } ) 

Or just a specific user's ID:

db.users.find({'username':'usernamehere'}).forEach( function(u) { print(u._id + \" ; \" + u.username); } )

Replace specific user ID's password in the database:

db.users.update( {'_id': 'useridhere'}, {$set: {'services.password.bcrypt': 'bcryptedpasswordhere'}}, {multi:true} )

My only issue with above (only time I needed it for recovery purposes), was that I didn't know which tool to use to generate a bcrypted password. So in the hurry I copied the hash from one account I already knew (my own). If someone knows a good command for creating one directly in bash, I assume it would do.

There are bcrypt password generators online, and various libraries you can use

For listing out any passwords in the database I used:

 db.users.find().forEach( function(u) { print(u.services.password.bcrypt + " ; " + u.username); } ) 

If you have deactivated users it may fail so use this for individual accounts.

However, you can get it for an individual user with:

db.users.find({'username':'SomeUserName'}).forEach( function(u) { print(u.services.password.bcrypt + " ; " + u.username); } ) 

Set a user config item:

db.users.update( {'username': 'SomeUserName'}, {$set: {'settings.preferences.showMessageInMainThread': 'true'}} )

Find a single user:

db.getCollection('users').find( {'username':'SomeUserName'} )

Get limited information:

db.getCollection('users').find({}, {"username":1, "settings.preferences.showMessageInMainThread":1})

Reset 2FA nonsense:

db.users.update({'username': 'SomeUserName'}, {$unset: {'services.totp': 1}});
db.users.update({'username': 'SomeUserName'}, {$unset: {'services.email2fa': 1}});

Database Backup

You can dump the tables to a directory of your choice:

mongodump --dumpDbUsersAndRoles -d rocketchat -o /root/rocketchatmongo

Database Restore

You can restore you database as follows:

mongorestore --restoreDbUsersAndRoles -d rocketchat -dir  /root/rocketchatmongo/rocketchat --quiet

Database Fix tables

To remove user data file links a variation on this link https://github.com/RocketChat/feature-requests/issues/718

mongo
use rocketchat
db.rocketchat_user_data_files.remove( { } )
db.runCommand({ compact: 'rocketchat_user_data_files', force: true });
quit;

Node usage

  • This should go to a new Node page for reference

Use n, an extremely simple Node version manager that can be installed via npm (See http://stackoverflow.com/questions/7718313/how-to-change-to-an-older-version-of-node-js)

Say you want Node.js v0.10.x to build Atom.

npm install -g n   # Install n globally
n 0.10.33          # Install and use v0.10.33 local only

Usage:

n                            # Output versions installed
n latest                     # Install or activate the latest node release
n stable                     # Install or activate the latest stable node release
n <version>                  # Install node <version>
n use <version> [args ...]   # Execute node <version> with [args ...]
n bin <version>              # Output bin path for <version>
n rm <version ...>           # Remove the given version(s)
n --latest                   # Output the latest node version available
n --stable                   # Output the latest stable node version available
n ls                         # Output the versions of node available


NPM Usage

To update your version of npm run the following

npm install -g npm

Or for a specific version:

npm install -g npm@3.10.9

DB settings

Typical standard setup:

rocketchat=service
   TCPPort=3000
   access=public
   mailPort=25
   mailURL=localhost
   status=enabled

Typical proxy subdomain setup:

rocketchat=service
   SSLProxy=yes
   TCPPort=3000
   access=private
   mailPort=25
   mailURL=localhost
   rootURL=chat.mydomain.co.uk
   status=enabled


Koozali SME v10

I am starting to look at running this under docker on v10

Some quick notes.

You will need

Docker https://wiki.contribs.org/Docker

Docker Compose (because it makes it easier to template) https://github.com/docker/compose/releases

Docker environment settings to disable 2FA

  - OVERWRITE_SETTING_Accounts_TwoFactorAuthentication_Enforce_Password_Fallback=false
  - OVERWRITE_SETTING_Accounts_TwoFactorAuthentication_Enabled=false

Mongo (I prefer to run a full instance rather than a docker one) https://wiki.contribs.org/MongoDB

Make sure you add replicaset support in Mongo and set it up:

mongo --eval "printjson(rs.initiate())"


I'll add more later, and try and make a full contrib in due course

FAQ

https://handbook.rocket.chat/company/tools/rocket.chat

Bugs

Please raise bugs under the SME-Contribs section in bugzilla and select the smeserver-rocketchat component or use

this link .


IDProductVersionStatusSummary
12390SME Contribs10.0RESOLVEDFirst import smeserver-rocketchat to SME 10 [smeserver-rocketchat] v0.4-1