Skip to content

Latest commit

 

History

History
189 lines (129 loc) · 5.64 KB

ubuntu.md

File metadata and controls

189 lines (129 loc) · 5.64 KB
Raw

Rocket.Chat on Ubuntu

Recommended Fastest Server Install

We recommend installing using our Docker and Docker Compose guide or using Snaps as they are the easiest way for you to get your server up and running on all supported Linux distributions (Ubuntu, etc).

If you would like to enable TLS on your site like this https://yoursite.com when using the snap, please this guide

Manual install

This installation guide was tested in the following environment:

  • Rocket.Chat 4.6.0
  • OS: Ubuntu 18.04 LTS, Ubuntu 19.04 and Ubuntu 20.04(Latest)
  • Mongodb 5.0
  • NodeJS 14.18.3

Requirements

Install Rocket.Chat

Install required packages/dependencies

sudo apt install -y curl build-essential graphicsmagick

Download the latest Rocket.Chat version:

curl -L https://releases.rocket.chat/latest/download -o /tmp/rocket.chat.tgz
tar -xzf /tmp/rocket.chat.tgz -C /tmp

Install (this guide uses /opt but feel free to choose a different directory):

cd /tmp/bundle/programs/server && npm install --production

If you're using the root account (not recommended), you'll have to use sudo npm install --unsafe-perm --production instead of the above.

sudo mv /tmp/bundle /opt/Rocket.Chat

Configure the Rocket.Chat service

Add the rocketchat user, set the right permissions on the Rocket.Chat folder and create the Rocket.Chat service file:

sudo useradd -M rocketchat && sudo usermod -L rocketchat
sudo chown -R rocketchat:rocketchat /opt/Rocket.Chat

Depending on how you install node, the binary path may be different. Save it to a variable.

NODE_PATH=$(which node)

Now save the systemd service file,

cat << EOF |sudo tee -a /lib/systemd/system/rocketchat.service
[Unit]
Description=The Rocket.Chat server
After=network.target remote-fs.target nss-lookup.target nginx.service mongod.service
[Service]
ExecStart=$NODE_PATH /opt/Rocket.Chat/main.js
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=rocketchat
User=rocketchat
[Install]
WantedBy=multi-user.target
EOF

The command above will create a barebone service file, this service file is what systemd will use to start your Rocket.Chat daemon/process.

Passing environment variables

Next you need to pass some environment variables to the running process. For more information of configuring via environment variables read this article.

Run:

sudo systemctl edit rocketchat

It should open up a text editor. Now write down the following,

[Service]
Environment=ROOT_URL=http://localhost:3000
Environment=PORT=3000
Environment=MONGO_URL=mongodb://localhost:27017/rocketchat?replicaSet=rs01
Environment=MONGO_OPLOG_URL=mongodb://localhost:27017/local?replicaSet=rs01

Change the values as you need. Save and exit.

MongoDB Configuration

Open the MongoDB config file (/etc/mongod.conf) in your favorite text editor. It is a simple YAML file.

Set the storage engine to wiredTiger.

storage:
  engine: wiredTiger

Enable replication, and name the replicaset rs01.

replication:
  replSetName: rs01

MongoDB replicaset is mandatory for Rocket.Chat > 1.0.0.

Your MongoDB config file should look something like the following:

storage:
  dbPath: /var/lib/mongodb
  journal:
    enabled: true
  engine: wiredTiger

systemLog:
  destination: file
  logAppend: true
  path: /var/log/mongodb/mongod.log

net:
  port: 27017
  bindIp: 127.0.0.1

processManagement:
  fork: true
  timeZoneInfo: /usr/share/zoneinfo

replication:
  replSetName: rs01

For a full list of available MongoDB config options read their official documentation.

Start MongoDB with the following command:

sudo systemctl enable --now mongod

Create the replicaset:

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

You can start Rocket.Chat now.

sudo systemctl enable --now rocketchat

Optional configurations

Configure firewall rule Configure a HTTP reverse proxy to access Rocket.Chat server [Configure mongo access control] [Configure production values for mongodb]

Configure your Rocket.Chat server

Open a web browser and access the configured ROOT_URL (http://your-host-name.com-as-accessed-from-internet:3000), follow the configuration steps to set an admin account and your organization and server info.