859
edits
Changes
From SME Server
Jump to navigationJump to search→Usage
'''[[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 manually installing Rocket.Chat [[Rocket_Chat|'''here''']]}}
{{Note box|Please note that there is also a howto on manually installing Rocket.Chat [[Rocket_Chat|'''here''' This 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}}
===Version===
{{ #smeversion: smeserver-rocketchat }}
==Required repos==
Add repos:
Add repos:
* [[epel]]
* [[epel]]
* [[Centos-sclo-rh]]
* [[mongoDB]]
* [[Docker]]
* [[User:ReetP|reetp]]
* [[User:ReetP|reetp]]
==RocketChat 0.40+==
===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
signal-event post-upgrade;signal-event reboot
System ➔ startup
System ➔ startup
use rocketchat
use rocketchat
db.rocketchat_settings.update({"_id" : "SMTP_Host"}, {$set: {"value":"mail.yourdomain.com"}})
db.rocketchat_settings.update({"_id" : "SMTP_Host"}, {$set: {"value":"mail.yourdomain.com"}})
db.rocketchat_settings.update({"_id" : "From_Email"}, {$set: {"value":"admin@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
Now we need to setup our subdomain
db domains set chat.mycompany.local domain Description RocketChat Nameservers internet \
db domains set chat.mycompany.local domain Description RocketChat Nameservers internet \
It should look like this:
It should look like this:
chat.mycompany.local=domain
chat.mycompany.local=domain
Nameservers=internet
Nameservers=internet (can be localhost)
ProxyPassTarget=http://127.0.0.1:3000/
ProxyPassTarget=http://127.0.0.1:3000/
TemplatePath=ProxyPassVirtualRocketchat
TemplatePath=ProxyPassVirtualRocketchat
letsencryptSSLcert=enabled (with letsencrypt support)
We need to set Rocket.Chat to listen on localhost now:
We need to set Rocket.Chat to listen on localhost now:
config setprop rocketchat rootURL chat.mycompany.domain SSLProxy yes
config setprop rocketchat rootURL chat.mycompany.domain SSLProxy yes
signal-event remoteaccess-update
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==
===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}}.
{{#bugzilla:columns=id,product,version,status,summary |sort=id |order=desc |disablecache=1 |component=smeserver-rocketchat |noresultsmessage="No open bugs found."}}
==Mongo DB examples==
==Mongo DB examples==
===Usage===
Example using mongo itself:
Example using mongo itself:
use rocketchat
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" : "SMTP_Host"})
db.rocketchat_settings.find({"_id" : "From_Email"})
db.rocketchat_settings.find({"_id" : "From_Email"})
db.getCollection("rocketchat_settings").find({"name":"Joe Blogs"})
db.getCollection("rocketchat_settings").find({"_id":{$regex:"^LDAP"}})
db.rocketchat_settings.findOne({_id : "From_Email"}, {_id:0, value: 1})
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.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.rocketchat_settings.update({"_id" : "SMTP_Host"}, {$set: {"value":"mail.yourdomain.com"}})
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==
==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)
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)
status=enabled
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 {{BugzillaFileBug|product=|component=|title=bugzilla}}and select the smeserver-rocketchat component or use
{{BugzillaFileBug|product=SME%20Contribs|component=smeserver-rocketchat |title=this link}}.
{{#bugzilla:columns=id,product,version,status,summary |sort=id |order=desc |disablecache=1 |component=smeserver-rocketchat |noresultsmessage="No open bugs found."}}
