Difference between revisions of "Rocket Chat:Contrib"

From SME Server
Jump to navigationJump to search
 
(70 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 Rcoket.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
+
 
 +
===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
+
 
 +
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
 
  signal-event post-upgrade;signal-event reboot
  
−
DB settings
 
  
−
  rocketchat=service
+
  System ➔ startup
−
    TCPPort=3000
+
+----------------------------------------------------+
−
    access=public
+
|                  SERVER RUNNING                    |
−
    mailPort=25
+
+----------------------------------------------------+
−
    mailURL=localhost
+
|                                                    |
−
    status=enabled
+
|      Version: 0.xx.x                              |
 +
|  Process Port: 3000                                |
 +
|      Site URL: <nowiki>http://rocketchat.local.net:3000</nowiki>    |
 +
|        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
  
−
rh-mongodb26-mongod=service
+
Now start the docker container (always run compose from the docker directory)
−
    TCPPort=27017
 
−
    access=private
 
−
    mongoURL=localhost
 
−
    status=enabled
 
  
−
BEFORE we login for the first time we need to set up mail settings correctly:
+
cd /home/e-smith/files/docker/configs
 +
docker-compose up -d rocketchat
 +
docker logs -f rocketchat
  
−
From bash:
+
db accounts setprop Primary SSL enabled
 +
signal-event ibay-modify Primary
  
−
mongo rocketchat --eval 'db.rocketchat_settings.update({"_id" : "SMTP_Host"}, {$set: {"value":"localhost"}});'
 
−
mongo rocketchat --eval 'db.rocketchat_settings.update({"_id" : "From_Email"}, {$set: {"value":"admin@yourdomain.com"}});'
 
  
−
We can check the individual values set like this:
+
==Bugs==
  
−
mongo rocketchat --eval 'db.rocketchat_settings.find({"_id":"From_Email"}, {_id:0, value:1}).shellPrint();'
+
Please raise bugs under the SME-Contribs section in {{BugzillaFileBug|product=|component=|title=bugzilla}}and select the smeserver-rocketchat component or use
−
  mongo rocketchat --eval 'db.rocketchat_settings.find({"_id":"SMTP_Host"}, {_id:0, value: 1}).shellPrint();'
+
  {{BugzillaFileBug|product=SME%20Contribs|component=smeserver-rocketchat |title=this link}}.
  
−
All values per _id:
 
−
mongo rocketchat --eval 'db.rocketchat_settings.find({"_id" : "SMTP_Host"}).shellPrint();'
 
−
mongo rocketchat --eval 'db.rocketchat_settings.find({"_id" : "From_Email"}).shellPrint();'
 
  
 +
{{#bugzilla:columns=id,product,version,status,summary |sort=id |order=desc |disablecache=1 |component=smeserver-rocketchat |noresultsmessage="No open bugs found."}}
  
−
Now restart rocketchat to reread the DB settings:
 
  
−
service rocketchat restart
+
==Mongo DB examples==
  
−
Login at http://yourdomain:3000
+
===Usage===
  
−
It will first get you to create an admin user.
+
Example using mongo itself:
  
−
If you have an issue with no email sent/received then login using the email address and password you just set
+
mongo
  
−
===Updates===
+
use rocketchat
  
−
If there is an update to Rocket.Chat I will add to my repo. You should just be able to run:
+
Show all collections in DB
 +
show collections
  
−
  yum --enablerepo=reetp install rocketchat
+
Show all entries in a collection
 +
  db.rocketchat_avatars.chunks.find()
  
−
You can also update the smeserver-rocketchat contrib in the same way
+
db.rocketchat_settings.find({"_id" : "SMTP_Host"})
 +
db.rocketchat_settings.find({"_id" : "From_Email"})
  
−
  yum --enablerepo=reetp install smeserver-rocketchat
+
  db.getCollection("rocketchat_settings").find({"name":"Joe Blogs"})
  
−
===SSL===
+
db.getCollection("rocketchat_settings").find({"_id":{$regex:"^LDAP"}})
 +
db.getCollection("rocketchat_settings").find({"value": {$regex: 'hostname', $options: 'i'}});
  
−
{{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 }}
+
db.rocketchat_settings.findOne({_id : "From_Email"}, {_id:0, value: 1})
 +
db.rocketchat_settings.findOne({_id : "SMTP_Host"}, {_id:0, value: 1})
  
−
{{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}}
+
db.rocketchat_settings.update({"_id":"From_Email"}, {$set: {"value":"admin@yourdomain.com"}})
 +
db.rocketchat_settings.update({"_id":"SMTP_Host"}, {$set: {"value":"mail.yourdomain.com"}})
  
−
It is recommended to add Letsencrypt support as detailed below.
 
  
−
We need some extra settings to enable SSL with ProxyPass.
+
Remove all entries in a collection (CAREFUL!!!!!!)
 +
db.rocketchat_avatars.chunks.remove({})
  
−
First install proxy pass rpm:
+
Help
 +
help
  
−
yum --enablerepo=fws install mod_proxy_wstunnel
+
Some more mongo commands for reference
  
−
Regenerate httpd.conf
+
https://github.com/RocketChat/Rocket.Chat/issues/15880#issuecomment-570070433
  
−
  signal-event remoteaccess-update
+
Directly check a specific user ID from bash:
 +
  mongo rocketchat --eval "db.users.find({'username':'usernamehere'}).forEach( function(u) { print(u._id + \" ; \" + u.username); } )"
  
−
Now we need to setup our subdomain
+
Log into rocketchat database:
 +
mongo rocketchat
  
−
  db domains set chat.mycompany.local domain Description RocketChat Nameservers internet \
+
Check out all the user IDs in the database:
−
TemplatePath ProxyPassVirtualRocketchat ProxyPassTarget http://localhost:3000/
+
  db.users.find().forEach( function(u) { print(u._id + ";" + u.username); } )
  
−
It should look like this:
+
Or just a specific user's ID:
 +
db.users.find({'username':'usernamehere'}).forEach( function(u) { print(u._id + \" ; \" + u.username); } )
  
−
  chat.mycompany.local=domain
+
Replace specific user ID's password in the database:
−
    Nameservers=internet
+
  db.users.update( {'_id': 'useridhere'}, {$set: {'services.password.bcrypt': 'bcryptedpasswordhere'}}, {multi:true} )
−
    ProxyPassTarget=http://127.0.0.1:3000/
 
−
    TemplatePath=ProxyPassVirtualRocketchat
 
  
 +
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.
  
−
We need to set Rocket.Chat to listen on localhost now:
+
There are bcrypt password generators online, and various libraries you can use
  
−
config setprop rocketchat rootURL localhost
+
For listing out any passwords in the database I used:
−
signal-event remoteaccess-update
 
−
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.users.find().forEach( function(u) { print(u.services.password.bcrypt + " ; " + u.username); } )
  
−
config setprop rocketchat access private
+
If you have deactivated users it may fail so use this for individual accounts.
−
signal-event remoteaccess-update
 
  
−
===Letsencrypt support===
+
However, you can get it for an individual user with:
  
−
{{Note box | 26 Aug 2016 - This should now work for a subdomain}}
+
db.users.find({'username':'SomeUserName'}).forEach( function(u) { print(u.services.password.bcrypt + " ; " + u.username); } )
  
−
You can add letsencrypt should you wish - please see https://wiki.contribs.org/Letsencrypt
+
Set a user config item:
  
−
You will need to add the domain key as follows, and add your letsencrypt certificates as per the wiki page:
+
db.users.update( {'username': 'SomeUserName'}, {$set: {'settings.preferences.showMessageInMainThread': 'true'}} )
  
−
db domains setprop chat.mycompany.local letsencryptSSLcert enabled
+
Find a single user:
  
−
Note that smeserver-rocketchat adds redirect on port 80 for the letsencrypt directory .well-known/acme-challenge
+
db.getCollection('users').find( {'username':'SomeUserName'} )
  
−
You should be able to reach:
+
Get limited information:
  
−
  http://chat.mycompany.local/.well-known/acme-challenge/
+
  db.getCollection('users').find({}, {"username":1, "settings.preferences.showMessageInMainThread":1})
  
−
This should redirect to:
+
Reset 2FA nonsense:
  
−
  https://chat.mycompany.local/.well-known/acme-challenge/
+
  db.users.update({'username': 'SomeUserName'}, {$unset: {'services.totp': 1}});
 +
db.users.update({'username': 'SomeUserName'}, {$unset: {'services.email2fa': 1}});
  
−
Anything else going to chat.mycompany.local should get to Rocket.Chat
+
===Database Backup===
  
−
===Bugs===
+
You can dump the tables to a directory of your choice:
  
−
Look for bugs :-) As the contrib is not in CVS please report them in the forum and I will try and keep an eye out.
+
mongodump --dumpDbUsersAndRoles -d rocketchat -o /root/rocketchatmongo
  
−
You ay get an error on install of the rocketchat rpm as follows:
+
===Database Restore===
  
−
npm WARN deprecated minimatch@2.0.10: Please update to minimatch 3.0.2 or higher to avoid a RegExp DoS issue
+
You can restore you database as follows:
  
−
This is due to the installed version of npm/node from SCL. Rocket.Chat should till work
+
mongorestore --restoreDbUsersAndRoles -d rocketchat -dir  /root/rocketchatmongo/rocketchat --quiet
  
−
==Mongo DB examples==
+
===Database Fix tables===
  
−
Example using mongo itself:
+
To remove user data file links a variation on this link
 +
https://github.com/RocketChat/feature-requests/issues/718
  
 
  mongo
 
  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
  
−
use rocketchat
 
  
−
db.rocketchat_settings.find({"_id" : "SMTP_Host"})
 
−
db.rocketchat_settings.find({"_id" : "From_Email"})
 
  
−
  db.rocketchat_settings.findOne({_id : "From_Email"}, {_id:0, value: 1})
+
==Koozali SME v10==
−
  db.rocketchat_settings.findOne({_id : "SMTP_Host"}, {_id:0, value: 1})
+
 
 +
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 {{BugzillaFileBug|product=|component=|title=bugzilla}}and select the smeserver-rocketchat component or use
 +
  {{BugzillaFileBug|product=SME%20Contribs|component=smeserver-rocketchat |title=this link}}.
  
  
−
db.rocketchat_settings.update({"_id" : "From_Email"}, {$set: {"value":"admin@reetspetit.info"}})
+
{{#bugzilla:columns=id,product,version,status,summary |sort=id |order=desc |disablecache=1 |component=smeserver-rocketchat |noresultsmessage="No open bugs found."}}
−
db.rocketchat_settings.update({"_id" : "SMTP_Host"}, {$set: {"value":"mail.reetspetit.info"}})
 

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
Retrieved from "https://wiki.koozali.org/index.php?title=Rocket_Chat:Contrib&oldid=43016"