Rocket Chat:Contrib
Version up to 0.61.2 will work with this contrib.
Later versions will need my newer smeserver-rocketchat-0.2.x contrib which uses docker.
smeserver-rocketchat contrib
This contrib aims to reduce some of the setup for rocketchat and add some flexibility with settings
Current version
3rd March 2018
Rocket RPM in my repo is 0.61.2
0.61.2 is likely to be the last version that can be installed direct to CentOS 6/ Koozali SME v9.x due to node module dependency requirements
I have tried to build 0.62.0 so far without success see this bug https://github.com/RocketChat/Rocket.Chat/issues/9943
https://reetspetit.com/smeserver/6/repoview/rocketchat.html
Latest source is here:
https://github.com/RocketChat/Rocket.Chat/tags
I am currently looking at running Rocket 0.62 on docker in CentOS 6 which I do have working using the existing local Mongo DB
I will post a link to a new wiki page when I have it tested further and know what I am doing with Docker
Required repos
Add repos:
/sbin/e-smith/db yum_repositories set epel repository \ 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 \ 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 \ 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 nodejs8 \ repository Name 'Node JS 8' \ BaseURL https://rpm.nodesource.com/pub_8.x/el/6/x86_64 \ EnableGroups no GPGCheck no Visible yes status disabled
signal-event yum-modify
yum --enablerepo=nodejs8 install nodejs nodejs-devel
RocketChat 0.40+
From Rocketchat 0.40 onwards you require a higher version of node than the one in the SCL repos.
Rocket.Chat v 60.0+ requires: node: v8.9.3 npm: v5.6.0
This can be installed from the node repo. The following is how to check and set up node versions manually - the rpm should sort this out for you.
Setup node versions:
Some of this is magic (to me!) and I still don't get the local and global stuff. Be careful with paths. See NPM Usage below for more.
The node rpm install node to /usr/bin but the npm 'n' module will install to /usr/local/bin
Check the version of node in /usr/bin
[root@test ~]# node -v v8.9.3
Install n version manager:
npm install -g n
Install specific node version (which will go in /usr/local/bin)
n 8.9.3Install the LTS version
n ltsList available versions
n lsInstall latest version of npm:
npm install -g npm
Install specific npm version:
npm install -g npm@5.6.0
Show the npm version
[root@test ~]# npm --version
5.6.0Install required rpms
yum --enablerepo=centos-sclo-rh,epel install scl-utils rh-python34-python rh-mongodb26-mongodb rh-mongodb26-mongodb-server \
GraphicsMagickYou should be able to install the smeserver-rocketchat RPM now
yum --enablerepo=reetp install smeserver-rocketchat
Don't post-upgrade yet.
config set rocketchat service TCPPort 3000 mailPort 25 mailURL localhost access public status enabled config set rh-mongodb26-mongod service TCPPort 27017 mongoURL localhost access private status enabled
signal-event post-upgrade;signal-event reboot
Now we should be able to install rocketchat itself - it is better to specify a version here in case a newer version breaks anything:
yum --enablerepo=reetp install rocketchat-0.59.6
Check the progress:
tailf /var/log/rocketchat.log
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
Restart Rocket.Chat to be sure:
service rocketchat restart
You should now be able to register a new account and get a confirmation email. Check /var/log/qpsmtpd/current for any errors.
If you have not set the From address you are likely to get:
Mail with no From header not accepted here
Errors
If you have issues make sure you stop the rocket chat service
service rocketchat stop
Check /var/log/rocketchat.log
Try running main.js manually:
export PORT=3000
export MAIL_URL=smtp://localhost:25
export MONGO_URL=mongodb://localhost:27017/rocketchat
export ROOT_URL=http://my.smeserver.net/opt/Rocket.Chat
node main.jsSSL with Proxypass
It is recommended to add Letsencrypt support as detailed below (see here for my contrib https://wiki.contribs.org/Letsencrypt)
We need some extra settings to enable SSL with ProxyPass.
Add the FWS repo:
db yum_repositories set fws repository \ BaseURL http://repo.firewall-services.com/centos/\$releasever \ EnableGroups no GPGCheck yes \ Name "Firewall Services" \ GPGKey http://repo.firewall-services.com/RPM-GPG-KEY \ Visible yes status disabled
Update the repos:
signal-event yum-modify
Install proxy pass rpm:
yum --enablerepo=fws install mod_proxy_wstunnel
Regenerate httpd.conf
signal-event remoteaccess-update
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 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:
config setprop rocketchat access private signal-event remoteaccess-update
You may find you need to clear your browser cache before it works correctly on https://chat.mycompany.local rather than http://chat.mycompany.local:3000
IF you have Letsencrypt support you can now set your main domain to SSL only:
db accounts setprop Primary SSL enabled signal-event ibay-modify Primary
Upgrades
To upgrade rocketchat:
yum --enablerepo=reetp install rocketchat
To upgrade the rocketchat configurator:
yum --enablerepo=reetp install smeserver-rocketchat
Bugs
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.
Manual config of templates
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 /etc/rc.d/init.d/rh-mongodb26-mongos start
Mongod fails to start after reboot
Sometimes it appears that mongo fails to start after a reboot.
I believe that this may be caused due to rocketchat being run by the forever service which means that rocketchat tries to keep running as the server shuts down despite mongod being stopped. This leaves lock files and prevents mongod from restarting properly. I think I probably need to look at the shutdown/start order of scripts.
A simple cure is as follows:
/etc/rc.d/init.d/rh-mongodb26-mongod stop
Remove the following files if they exist:
rm /var/opt/rh/rh-mongodb26/lib/mongodb/mongod.lock rm /var/opt/rh/rh-mongodb26/run/mongodb/mongod.pid
Restart the mongod service:
/etc/rc.d/init.d/rh-mongodb26-mongod start
Restart the rocketchat service:
service rocketchat restart
The following is simpler and appears to work:
service rocketchat stop /etc/rc.d/init.d/rh-mongodb26-mongod restart service rocketchat start
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.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); } )
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
Node usage
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
rh-mongodb26-mongod=service TCPPort=27017 access=private mongoURL=localhost 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
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 https://docs.rocket.chat/installation/manual-installation/centos
I'll add more later, and try and make a full contrib in due course
CentOS 7 notes
Setup storage engine and replication for MongoDB (mandatory for versions > 1), and enable and start MongoDB and Rocket.Chat:
They still recommend mmapv1 but it is probably better to stick with the default WiredTiger. Here's how to change if required:
sed -i "s/^# engine:/ engine: mmapv1/" /etc/mongod.conf
You MUST initialise a replicaset so we must add this to the conf file:
sed -i "s/^#replication:/replication:\n replSetName: rs01/" /etc/mongod.conf
Start Mongo
systemctl enable mongod && sudo systemctl start mongod
Initiate the set:
mongo --eval "printjson(rs.initiate())"