😁
User Guide
6.5
6.5
  • Rocket.Chat
  • Deploy
    • Deploy Rocket.Chat
      • System Requirements
      • Deploy with Docker & Docker Compose
      • Deploy with AWS
      • Deploy with Snaps
      • Updating Rocket.Chat
      • Scaling Rocket.Chat
        • Microservices
        • Running Multiple Instances
        • Automation Tools
          • Ansible
          • OpenShift
          • Vagrant
      • Additional Deployment Methods
        • Deploy with Kubernetes
        • Deploy with Digital Ocean
        • Deploy on Google Compute Engine
        • Deploy with Ubuntu
        • Deploy with CentOS
        • Deploy on Kali
        • Deploy on Debian
        • Deploy on IBM Cloud
        • Deploy on Windows 10
        • Plug-in Deployments
        • Unsupported Methods
          • OpenSUSE Leap 42.2
          • FreeBSD
            • Deploying Rocket.Chat Server Binaries on a FreeBSD system
          • Windows Server
          • Linode
          • Scalingo
          • Cloudron.io
          • Jelastic
          • Aliyun
          • Galaxy
          • Syncloud
          • OpenShift
  • Setup and Configure
    • Rocket.Chat Environment Configuration
      • NodeJs Configuration
      • MongoDB Configuration
        • MongoDB URI Authentication
        • MongoDB Backup and Restore
        • Passing extra options to the Mongo driver
        • Configure a replica set for MongoDB
        • Migrating database from Meteor built in MongoDB
        • MongoDB mmap to wiredTiger migration
        • Supported Mongo Versions
      • Firewall Configuration
      • Additional Configurations
        • Running in a sub folder with Apache
        • Univention Corporate Server (UCS)
        • Setting Up Client SSL Certificate Authentication for Rocket.Chat
        • Setting up Process Managers and Init Systems
      • Configuring SSL Reverse Proxy
      • Environment Variables
    • Installing Client Apps
      • Desktop & Mobile Apps
      • Minimum Requirements for Client Apps
    • Enterprise License Application
    • Accessing Your Workspace
      • Rocket.Chat Setup Wizard
      • Admin Account Creation
      • Basic White-labeling
      • Inviting Users
    • Advanced workspace management
      • Authentication
        • OpenID Connect
          • Gluu Server 4.0
          • Keycloak
          • Okta Identity Cloud Service
        • iframe based Single Sign On
      • Google Translate Integration
      • Managing Settings Using Environmental Variables
      • Identity Management (EE vs CE)
      • Database Migration
      • Restoring an Admin User
      • CDN
      • Troubleshooting
      • Client Compatibility Matrix
    • Enterprise Edition Trial
    • Rocket.Chat Air-gapped Deployment
      • Offline Workspace Registration
      • Offline License
      • Air-gapped workspace Configuration
      • Air-gapped App Installation
    • Roles in Rocket.Chat
  • Use Rocket.Chat
    • User Guides
      • Access your workspace
      • Main Menu
      • User Panel
        • My Account
          • Manage Devices
      • Rooms
        • Channels
          • Create a new Channel
          • Edit A Channel
          • Manage Channel Members
          • Search Messages in a Channel
        • Teams
          • Create a new Team
          • Edit a Team
          • Manage Team Members
          • Manage Team Channels
          • Teams Enterprise Edition
        • Discussions
          • Create a new Discussion
          • Edit A Discussion
          • Search Messages in Discussion
          • Manage Discussion Members
        • Direct Messages
          • Create a new Direct Message
          • Direct Message Actions
        • Threads
          • Create a New Thread
        • Room Roles
      • Messages
        • Message Actions
        • Off-the-record (OTR) Messaging User Guide
      • Notifications
      • Security Bundle
        • Data Loss Prevention User Guide
        • Antivirus ClamAV App
        • End to End Encryption User Guide
        • Two Factor Authentication User Guide
      • Keyboard Shortcuts
    • Workspace Administration
      • Go Fully Featured
      • Workspace
      • Registration
      • Engagement
      • Moderation
      • Federation
      • Rooms
      • Users
        • Guest users
        • Add users through Identity management and authentication services
      • Invites
      • User Status
      • Permissions
        • Setting's Permission
      • Device Management
      • Email Inboxes
      • Mailer
      • Third-party Login
      • Integrations
        • AppVeyor
        • Azure Alerts
        • BitRocket
        • Dead Simple Screen Sharing
        • EasyRedmine
        • Giphy Integrations
        • GitLab
        • Google Calendar
        • GitHub
        • Graylog
        • Jenkins notifications via Rocket.Chat Marketplace
        • JFrog Xray
        • MicroBadger
        • Microsoft Teams
        • NewRelic
        • Nextcloud and WebDAV integrations
        • Nextcloud Rocket.Chat App
        • Nixstats notification
        • PagerDuty
        • Prometheus
        • Grafana
        • Review Board
        • RunDeck Job Notifications
        • Sentry
        • Simple Telegram Bot
        • TravisCI
        • Uptime Robot
        • Zapier
        • django-rocketchat-auth 1.2
        • Add Jira notifications via webhook
      • Import
        • Import from HipChat
        • Import from Slack
          • SlackBridge
        • Import CSV
      • Logs
      • Sounds
      • Emoji
      • Settings
        • Accounts
          • Custom Fields
        • Analytics
        • Assets
        • Bots
        • CAS
        • Conference Call
        • Custom Emoji Filesystem
        • Custom Sound Filesystem
        • Device management settings
        • Discussion
        • E2E Encryption
        • Email
          • Edit your Email Content
          • Direct email reply
          • Email configuration
        • Enterprise
        • Federation
          • Matrix Bridge
            • Matrix Admin Guide
              • Matrix Homeserver Setup
                • Matrix Allow/Block List
              • Matrix Bridge Configuration
            • Matrix User's Guide
              • Create federated rooms
              • Invite external users to your Rocket.Chat server
              • Communicate with a federated user
              • Search and join public channels on the Matrix network
              • Assign roles for users in federated rooms
            • Matrix Bridge FAQs
          • Rocket.Chat Basic Federation
            • Cross-server Federated Channels
        • File Upload
          • Minio
          • Recommendations for File Upload
          • File Upload FAQs
        • General
          • Net Promoter Score (NPS) survey
        • IRC Federation
        • Layout
        • LDAP
          • LDAP Connection Setting
          • LDAP User Search
          • LDAP Data Sync Settings
          • LDAP Enterprise Settings
          • LDAP Examples
        • Logs
        • Message
        • Meta
        • Mobile
        • OAuth
          • Facebook OAuth Setup
          • Google OAuth Setup
          • GitLab OAuth Setup
          • GitHub OAuth Setup
          • GitHub Enterprise OAuth Setup
          • LinkedIn OAuth Setup
          • NextCloud OAuth Setup
          • WordPress OAuth Setup
          • MS Office 365 OAuth Setup
          • Other OAuth Setup
        • Omnichannel Admin's Guide
          • Queue Types (Routing Algorithm)
        • OTR
        • Outlook Calendar
        • Push
        • Rate Limiter
        • Retention Policy
        • SAML
          • Rocket.Chat server settings
          • Simple SAML php
          • Active Directory Federation Services
          • Oracle Identity Cloud Service
          • Keycloak
        • Search
        • Setup Wizard
        • SlackBridge
        • Smarsh
        • SMS
        • Threads
        • Troubleshoot
        • User Data Download
        • Voice Channel
        • Webdav Integration
        • WebRTC
    • Omnichannel
      • Current Chats
      • Reports
      • Analytics
      • Real-time Monitoring
      • Managers
      • Agents
      • Departments
      • Custom Fields
      • Livechat Triggers
      • Livechat Widget Installation
      • Livechat Widget Appearance
      • Webhooks
      • Business Hours
      • Monitors
      • Units
      • Canned Responses
        • Canned Responses Omnichannel Manager's Guide
      • Tags
      • SLA Policies
      • Priorities
    • Message Auditing
      • Review All Message Auditing Panel Search Results
      • Check Historical Edits and Deletions of Messages
      • Assign Message Auditing Permissions to Specific Users
    • Message Auditing Log
    • Rocket.Chat Cloud
      • Create your new cloud account
      • Manage your cloud account
        • Custom domain for your Cloud-hosted workspace
        • Profile
        • Organization Settings
        • Workspaces
        • Invoices
        • Payment Methods
        • Support
        • Security
        • Contact Sales
      • Cloud Account Setup Wizard
    • Rocket.Chat Voice Channel
      • Getting Started with Voice Channel
      • Voice Channel Admin Guide
        • Configure without previously having a PBX server
          • SIP Extensions
          • Configure asterisk manager interface and users
        • Configure with an active PBX server
          • Associate agents with extensions in Rocket.Chat
      • Voice Channel Technical Specification
      • Voice Channel Agent Guides
        • How to make myself available to accept calls?
        • How to take a call in Rocket.Chat voice channel?
        • How to initiate an outbound call as an agent?
      • Voice Channel FAQs
    • Rocket.Chat Conference Call
      • Conference Call Admin Guide
        • Pexip app
        • Jitsi app
        • BigBlueButton (BBB) app
        • Google Meet app
      • Conference Call User's Guide
      • Omnichannel Video/Audio Call Configuration
    • Rocket.Chat Federation
    • Rocket.Chat Mobile
      • Rooms on Rocket.Chat Mobile
      • Messages and Threads on Mobile
      • Push Notifications
        • Secured Push Notification
        • Push Notifications User Guide
    • Omnichannel Agent's Guides
      • Omnichannel Conversation
      • Omnichannel Queue
      • Omnichannel Contact Center
        • Omnichannel Contact Manager Assignment
      • Email Inboxes
  • Extend Rocket.Chat Capabilities
    • Rocket.Chat Marketplace
      • Rocket.Chat Public Apps Guides
        • Omnichannel Apps
          • SMS
          • Telegram App
            • Telegram Agent's Guide
          • Rasa App
          • Salesforce CRM Integration
            • Salesforce CRM Agent's Guide
          • HubSpot CRM
            • HubSpot CRM Agent's Guide
          • Dialogflow App
            • Upload File To Ongoing Dialogflow Chats
          • Twitter App
            • Twitter App Agent's Guide
          • Facebook App
            • Facebook App Agent's Guide
          • WhatsApp
            • WhatsApp Agent's Guide
          • WhatsApp Sandbox
            • WhatsApp Sandbox Agent's Guide
          • Instagram Direct
            • Instagram Direct Agent's Guide
          • WhatsApp Cloud App
            • Configure Whatsapp Cloud App
            • Using WhatsApp Cloud App
        • Atlassian Apps
          • Jira Server v2.0
          • Bamboo Integration
          • Bitbucket Server
          • Confluence Server
          • Jira Server
        • Pexip App
        • Jitsi app
        • BigBlueButton (BBB) app
        • Google Meet app
        • Trello
          • Using the Trello App
        • Zoom
          • Install Zoom App
        • Data Loss Prevention (DLP) App
        • Poll
        • Poll Plus
          • Poll Plus Features
        • Microsoft Teams Bridge
          • Using Microsoft Teams Bridge
        • GitHub App
          • Using GitHub App
        • Google Drive
          • Using the Google Drive App
        • Google Calendar
          • Using the Google Calendar App
        • Zapier App
          • Install Zapier App
          • Using Zapier App
        • ChatGPT App
          • Install ChatGPT App
          • Using ChatGPT App
      • App Storage Location
    • Integrations
    • Rocket.Chat API
  • Resources
    • Frequently Asked Questions
      • Accessing your workspace FAQs
      • My Account FAQs
      • Registration
      • Message Privacy
      • Localization
      • Apps FAQs
      • Update FAQs
      • WhatsApp Cloud API FAQs
      • Cloud FAQs
      • Support FAQs
      • Whatsapp Business App FAQs
      • Identity Management EE FAQ
      • Deployment FAQ
        • Updating Rocket.Chat FAQ
        • Snaps FAQ
      • Omnichannel FAQs
    • Brand and Visual Guidelines
      • Logo
      • Typography
      • Colors
      • Patterns
      • Iconography
      • Photos
      • Brand Usage Examples
      • Media Kit
    • Development Docs
    • Rocket.Chat's Support Structure
      • Enterprise Support and Version Durability
        • Enterprise Support Plans
      • Community Resources
      • Legacy Support
  • Contribute to Rocket.Chat
    • Contributor Code of Conduct
    • How Can I Help?
    • Github Sponsorship
    • Annual Contribution Programs
  • PRIVACY AND SECURITY
    • Privacy and Security Policies
      • Rocket.Chat Privacy Policy
        • Subprocessors
      • Privacy Policy Facebook Messenger
      • Security Policy
    • Security Center
      • Compliance Resources and Certifications
      • Security fixes and updates
        • cve-2022-32211
      • End-to-End Encryption Specifications
    • Privacy Center
      • GDPR
        • Data Processing Agreement
      • LGDP
        • Nomeação do Encarregado pelo Tratamento de Dados Pessoais
  • LEGAL AND COMPLIANCE
    • Rocket.Chat Terms
      • Terms of Service
        • Cloud Deployment Terms/Cloud Terms
      • Master Services Agreement for Self Managed Workspaces
      • Supplemental Terms
        • Master Service Agreement for Professional Services
    • Compliance Center
      • DMCA Policy
      • Law Enforcement
        • Guidelines for Law Enforcement
        • Censorship and Harmful Content
        • Server Lookup
      • Code of Conduct: Services
    • Legal Center
Powered by GitBook
On this page
  • Preparation Steps
  • Deploy Rocket.Chat with Snaps
  • Snap Backup and Restore
  • Auto SSL with Snaps
  • Updating Rocket.Chat Snap
  1. Deploy
  2. Deploy Rocket.Chat

Deploy with Snaps

PreviousDeploy with AWSNextUpdating Rocket.Chat

Rocket.Chat 6.0 is our most secure and scalable version yet. It includes 10 security patches, 9 brand-new features, and 25+ overall platform enhancements. Visit our to learn more about what’s new in this latest version. !

Snaps are a convenient way to rapidly deploy a Rocket.Chat instance for development or discovery purposes. We do not recommend snaps for managing production environment.

Installing software on Linux can now be done easily with the use of Snaps. They are self-contained packages with all necessary files and dependencies, ensuring easy installation and updates. Deploying Rocket.Chat with Snaps offers seamless deployment on any Linux distribution, providing a secure and isolated workspace. It also auto-updates when a new version of Rocket.Chat is released.

In this guide, you'll learn how to:

Preparation Steps

Prerequisites

  • A Linux-based system (Ubuntu, Debian, Fedora, etc.)

  • AVX/AVX2 supported CPU to run Mongo 5.0 for Rocket.Chat workspaces on version 6.0 & above.

Install Snaps

Snap is pre-installed in most modern Linux distributions. If it's not, see the.

Deploy Rocket.Chat with Snaps

  • To install Rocket.Chat with snap on Ubuntu, run the following command:

sudo snap install rocketchat-server

This command installs the latest available version on Rocket.Chat. You can also specify the installation by track.

Moving Between Major Releases

With Snap tracks, you can smoothly transition between major releases of Rocket.Chat (from 2.x to 3.x or from 3.x to 4.x). These tracks enable you to remain on a specific release while receiving updates exclusively for that particular track. For instance, you can confidently switch to a new major release with the following command:

sudo snap switch rocketchat-server --channel=4.x/stable

Snap tracks allow you to keep your Rocket.Chat server up-to-date with the latest features while choosing your preferred release version.

Configuring Rocket.Chat with Snaps

  • To see the list of snap variables to configure for your Rocket.Chat server, run the following command:

snap get rocketchat-server

It displays a list of values like this:

Key                Value
backup-on-refresh  disable
ignore-errors      false
mongo-oplog-url    mongodb://localhost:27017/local
mongo-url          mongodb://localhost:27017/parties
port               3000
siteurl            http://localhost:3000
  • To set any of the variables, run this command:

sudo snap set rocketchat-server <variable-name>=<value>

Configuring MongoDB

From track 4.x, you can configure your MongoDB. The configuration file is located in /var/snap/rocketchat-server/current/mongod.conf.

Snap Backup and Restore

Snap Backup and Restore is a handy tool that allows you to create backups of your Rocket.Chat instance and restore them as needed.

Backup Rocket.Chat Snap Data

You can enable automatic backup on each snap refresh by executing this command:

sudo snap set rocketchat-server backup-on-refresh=enable

To backup the data on your snap installation,

  • Stop your rocketchat-server by running

sudo service snap.rocketchat-server.rocketchat-server stop

While the rocketchat-server service should be stopped, the rocketchat-mongo service should be kept running.

sudo service snap.rocketchat-server.rocketchat-mongo status | grep Active
   Active: active (running) (...)
  • Execute the backup command:

sudo snap run rocketchat-server.backupdb
  • A successful backup will return this:

[+] A backup of your data can be found at /var/snap/rocketchat-server/common/backup/rocketchat_backup_<timestamp>.tar.gz
  • Start your rocketchat-server

sudo service snap.rocketchat-server.rocketchat-server start
  • Copy your backup to a different system for safekeeping.

Restore Rocket.Chat Snap Data

To restore your backed-up snap data,

  • Stop your rocketchat-server by running this command:

sudo service snap.rocketchat-server.rocketchat-server stop

While the rocketchat-server service should be stopped, the rocketchat-mongo service should be kept running.

sudo service snap.rocketchat-server.rocketchat-mongo status | grep Active
   Active: active (running) (...)
  • Copy your backup file to the snap's common folder:

sudo cp rocketchat_backup.tgz /var/snap/rocketchat-server/common/
  • Run the restore command:

sudo snap run rocketchat-server.restoredb /var/snap/rocketchat-server/common/rocketchat_backup.tgz

If you are replacing an existing database, you get a warning message.

ATTENTION

  • Your current database WILL BE DROPPED prior to the restore!

  • Do you want to restore?

    • 1) Yes

    • 2) No

  • Choose your restore option.

  • If it is successfully done, you will see an output similar to:

[*] Extracting backup file...
[*] Restoring data...
[*] Preparing database...
[+] Restore completed! Please restart the snap.rocketchat services to verify.
  • Start your rocketchat-server

sudo service snap.rocketchat-server.rocketchat-server start

Auto SSL with Snaps

Starting from release 0.73, the snap includes Caddy, which utilizes Let's Encrypt to enable TLS protection for your communications. Snap hooks ensure easy configuration of Caddy, including proper DNS setup, before starting Caddy with Let's Encrypt support.

To set up Auto SSL with Snaps for 4.x latest AMD64 snaps or 3_.x latest ARM64 snaps_,

  • Set the SiteUrl to your domain using the following command, esure it is prefixed with https:

sudo snap set rocketchat-server siteurl=https://<your domain>
  • Start Caddy and restart the snap services.

sudo systemctl enable --now snap.rocketchat-server.rocketchat-caddy 
sudo snap restart rocketchat-server

To set up Auto SSL with Snaps for older snaps,

  • To enable TLS and Let's Encrypt certificates:

  1. Input a URL starting with HTTPS

  2. Own the domain name you would like to use.

  3. Ensure the proper DNS record is set up to link your domain name to your public IP address. Keep in mind that it may take some time for DNS records to propagate.

  • Run the following commands to check that configuration is set up correctly before starting the services:

sudo snap set rocketchat-server caddy-url=https://<your-domain-name>
sudo snap set rocketchat-server caddy=enable
sudo snap set rocketchat-server https=enable
sudo snap run rocketchat-server.initcaddy
  • If no errors are found, it is safe to restart Rocket.Chat and Caddy:

sudo systemctl restart snap.rocketchat-server.rocketchat-server.service
sudo systemctl restart snap.rocketchat-server.rocketchat-caddy.service
  • In case you don't want to configure TLS for your site or want to remove TLS configuration:

sudo snap set rocketchat-server https=disable
sudo snap set rocketchat-server caddy-url=http://<your-domain-name>
sudo snap set rocketchat-server caddy=enable
sudo snap run rocketchat-server.initcaddy

If no errors were found, it is safe to restart Rocket.Chat and Caddy:

sudo systemctl restart snap.rocketchat-server.rocketchat-server.service
sudo systemctl restart snap.rocketchat-server.rocketchat-caddy.service

To view the Caddy log, run this command:

sudo snap logs -f rocketchat-server.rocketchat-caddy

Configure Caddy yourself or use another HTTP Proxy

For 4.x latest AMD64 snaps or 3.x latest ARM64 snaps,

Both caddy v2 and caddy v1 (EOL) is delivered in the snap, v2 is prioritized over v1.

  • To configure Caddy yourself, place the Caddyfile in the /var/snap/rocketchat-server/current/ directory and restart rocketchat-server.

sudo snap restart rocketchat-server
  • To use another reverse proxy, disable Caddy by running this command:

sudo systemctl disable snap.rocketchat-server.rocketchat-caddy

For older snap versions,

  • If you would like to use a different https proxy or prefer other options in your Caddy configuration, you can choose to disable Caddy by running this command:

sudo snap set rocketchat-server caddy=disable
  • Edit the Caddyfile found at /var/snap/rocketchat-server/current/Caddyfile and write your configuration.

  • Replace _caddy-url_ and _port_ with your site information. For example, suppose I have example-domain.com directed towards my server.

  • Be sure that your DNS has finished resolving before attempting to enable TLS. To test your DNS you can use http:

http://example-domain.com

reverse_proxy localhost:3000
  • Restart Caddy:

sudo systemctl reload snap.rocketchat-server.rocketchat-caddy
  • You can check that the Caddy service started correctly by running:

sudo systemctl status snap.rocketchat-server.rocketchat-caddy
  • Once that is tested and resolved, to get secured communications, you can remove the http://:

example-domain.com

reverse_proxy localhost:3000

If you use an IP address, Caddy will still serve your site over TLS, but using a self-signed certificate.

  • Restart the Caddy service by running:

sudo systemctl reload snap.rocketchat-server.rocketchat-caddy
  • You can check that the Caddy service started correctly by running:

sudo systemctl status snap.rocketchat-server.rocketchat-caddy

If the configuration is succesfull, the website should now be easily accessible at https://example-domain.com.

Updating Rocket.Chat Snap

With the Rocket.Chat snap installation, you'll always be on the latest track at the setup time, ensuring access to the latest releases.

  • To force an update, run this command**:**

sudo snap refresh rocketchat-server
  • To update to a major version, switch to a specific track by executing this command:

sudo snap switch rocketchat-server --channel=x.x/stable

You'll then receive updates related to that track..

  • To update to a new version, execute this command:

sudo snap refresh rocketchat-server --channel=x.x/stable

The channel format is "x.x/stable," where the first "x" represents the major version, and the second "x" remains unchanged. For example, for major version 6, the channel is "6.x/stable," and for major version 5, it's "5.x/stable." In each "6.x/stable" channel, you will receive all minor and patch release updates specifically for that major version (in this case, major version 6).

To access your Rocket.Chat workspace, open a web browser and navigate to the specified ROOT URL (http://localhost:3000). Follow the configuration prompts to

For all the configuration options, see

If your DNS is not working, you could be instantly for up to a week.

Using an IP address will not work for automatically enabling TLS with a publicly-trusted certificate. You must use a valid hostname for a trusted certificate. See the for more information.

Before you proceed, see the .

It is highly advised to before upgrading.

Before a major version update, check the . Major releases are often delayed by a couple of weeks to gather feedback and apply minor patches before the final release.

Learn more about track changes in this .

In addition to the latest track, Rocket.Chat offers three other channels: stable, candidate, and edge. For more information on these channels, refer to the .

If you have any concerns or issues with your deployment, see .

website
Update now
Deploy Rocket.Chat using Snap
Backup & Restore Rocket.Chat Snap data
Auto SSL with Snaps
Update Rocket.Chat Snap
Snaps installation guide
configure your workspace.
MongoDB's official documentation.
throttled by Let's Encrypt
official guide
general guidelines for updating Rocket.Chat
back up your data
forum's announcement section
discussion
official guide
Snaps FAQ