SUMMARY.md

Table of contents

• Rocket.Chat Documentation
• Getting Support
  • Enterprise Support
    • Enterprise Support Plans
  • Community Resources
  • Legacy Support
• Development Docs

Quick Start

• Deploying Rocket.Chat
  • Introduction/Prerequisites
    • Choosing a Deployment Method
  • Hardware Requirements
  • Rapid Deployment Methods
    • Docker & Docker Compose
      • Docker Containers
        • Available Images
        • Docker Mongo Backup and Restore
        • systemd
        • High Availability
        • MongoDB MMAP to WiredTiger Migration
    • Snaps
      • Configuring MongoDB
      • Auto SSL with Snaps
      • Snap Backup and Restore
      • Snap FAQ
    • RocketChatCTL
    • Kubernetes with Helm
  • Cloud Deployments
    • AWS
    • Google Compute Engine
    • IBM Cloud
    • DigitalOcean
  • Other Deployment Methods
    • Manual Installation
      • Rocket.Chat in CentOS
      • Debian Based Distros
        • Rocket.Chat on Debian
        • Rocket.Chat on Ubuntu
        • Rocket.Chat on Kali Linux
      • Updating
        • Updating from 0.x.x to 0.40.0
        • Updating to 1.0
    • Nonofficial 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
    • Windows 10
    • Plug-in Deployments
      • Drupal Plug-in
      • Pidgin Plug-in
• Scaling Rocket.Chat
  • Microservices Setup
  • Running Multiple Instances
  • Automation Tools
    • Ansible
    • Kubernetes using Helm
    • OpenShift
    • Vagrant
• Accessing Your Workspace
  • Rocket.Chat Setup Wizard
  • Admin Account Creation
  • Inviting Users
  • Starting & Stopping Docker Compose
• Installing Client Apps
  • Rocket.Chat Desktop & Mobile Apps
  • Minimum Requirements
• Updating Rocket.Chat
• Environment Configuration
  • Node Configuration
    • Supported NodeJs Version
    • Runtime 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
  • Extras
    • Running in a sub folder with Apache
    • Univention Corporate Server (UCS)
    • Setting up Process Managers and Init Systems
  • Configuring SSL Reverse Proxy
  • Environment Variables

Guides

• User Guides
  • Connect to a Rocket.Chat Server
  • Registering an account
  • Rooms
    • Channels
      • Create a new Channel
      • Types of Channels
      • Channel Actions
        • Mark Channel as Favorite
        • Channel Information
        • Search Messages in a Channel
        • Members List of a Channel
          • Add User to a Channel
          • Invite Users to a Channel
        • Channel Notifications
        • Channel Message List
        • Streaming in a Channel
        • Prune Messages from a Channel
    • Teams
      • Create a new Team
      • Teams Channels
      • Team Actions
        • Add an existing channel to a team
        • Team Information (view and edit)
        • Create New Channel for a Team
        • Delete a Team (Team Owner Permission)
        • Team's Channel Auto-Join
        • Hide or Leave a Team
        • Remove a Channel from Team
        • Delete a Team's Channel
        • Transforming a channel into a team
      • Teams Members
      • Teams Enterprise Edition
    • Discussions
      • Create a new Discussion
      • Discussion Actions
        • Mark Discussion as Favorite
        • Discussion Info
        • Search Messages in Discussion
        • Member List of a Discussion
        • Discussion Notifications
        • Prune Messages from a Discussion
    • Messages
      • Message Actions
      • Off-the-record (OTR) Messaging User Guide
    • Direct Messages
      • Types of Direct Messages
      • Create a new Direct Message 1:1
      • Create new Multi-users Direct Message 1:M
      • Direct Messages Action
        • Mark Direct Message as Favorite
        • View User Information
        • Block User in Direct Message
        • Threads in Direct Messages
        • Direct Messages Discussions
        • Search Direct Messages
        • Files in Direct Messages
        • Direct Messages Notifications
        • Star Messages in Direct Message
        • Pinned Messages in Direct Message
        • Prune Messages from Direct Message
        • Export Messages in Direct Message
    • Threads
      • Create a New Thread
      • Thread Actions
        • Expand Thread
        • Following Threads
        • Close Threads
  • Cross-server Federated Channels
  • Security Bundle
    • End to End Encryption User Guide
    • Antivirus ClamAV App
    • Data Loss Prevention User Guide
    • Two Factor Authentication User Guide
  • Keyboard Shortcuts
  • User Panel
    • My Account
      • Preferences
      • Profile
      • Security
      • Personal Access Token
      • Manage Devices
• Administration
  • Basic White-labeling
  • Identity Management (EE vs CE)
  • Admin Panel
    • Go Fully Featured
    • Info
    • Import
      • Import from HipChat
        • HipChat Cloud
        • HipChat Server / Data Center
      • Import from Slack
        • SlackBridge
      • Import CSV
    • Users
      • Invite users to your Rocket.Chat workspace
      • Add new users
        • Add users by Identity management and authentication services
      • Guest users
    • Rooms (aka Channels)
    • Invites
    • Connectivity Services
    • View Logs
    • Federation Dashboard
    • Apps
    • Email Inboxes
    • Custom Emoji
    • Integrations
      • AppVeyor
      • Azure Alerts
      • BitRocket
      • Dead Simple Screen Sharing
      • EasyRedmine
      • Giphy Integrations
      • GitHub
      • GitLab
      • Google Calendar
      • Graylog
      • Guggy
      • Jenkins notifications via Rocket.Chat API
      • JFrog Xray
      • MicroBadger
      • Microsoft Teams
      • NewRelic
      • Nextcloud and WebDAV integrations
      • Nextcloud Rocket.Chat App
      • Nixstats notification
      • PagerDuty
      • Prometheus
      • Review Board
      • RunDeck Job Notifications
      • Sentry
      • Simple Telegram Bot
      • TravisCI
      • Uptime Robot
      • Zapier
      • django-rocketchat-auth 1.2
      • Add Jira notifications via webhook
    • OAuth Applications
    • Mailer
    • Custom User Status
    • Permissions
    • Settings
      • Accounts
        • Custom Fields
      • Analytics
      • Assets
      • Atlassian Crowd
      • Blockstack
      • Bots
      • CAS
      • Custom Emoji Filesystem
      • Custom Sound Filesystem
      • Discussion
      • E2E Encryption
      • Email
        • Edit your Email Content
        • Direct Email reply
        • Email Configuration
      • Enterprise
      • Federation
        • Matrix Bridge
          • Matrix Admin Guide
            • Matrix Homeserver Setup
            • Matrix Bridge Configuration
          • Matrix User's Guide
            • Create a federated rooms
            • Invite external users to your Rocket.Chat server
            • Communicate with a federated user
          • Matrix Bridge FAQs
        • Rocket.Chat Federation (Will be deprecated on 6.0.0)
      • File Upload
        • Amazon S3
        • Google Cloud Storage
        • Minio
        • WebDAV
        • Recommendations for File Upload
        • File Upload FAQs
      • IRC
      • IRC Federation
      • Layout
      • LDAP
        • LDAP Connection Setting
        • LDAP User Search
        • LDAP Data Sync Settings
        • LDAP Enterprise Settings
        • LDAP Examples
      • Call Center
      • Livestream & Broadcasting (Youtube)
      • Logs
      • Message
      • Meta
      • Mobile
      • OAuth
        • Apple OAuth Setup
        • NextCloud OAuth Setup
        • Facebook OAuth Setup
        • Google OAuth Setup
        • GitLab OAuth Setup
        • GitHub OAuth Setup
        • WordPress OAuth Setup
        • MS Office 365 OAuth Setup
        • Other OAuth Setup
      • Omnichannel Admin's Guide
        • Queue Types (Routing Algorithm)
      • OTR
      • Push (Notifications Admin Guide)
      • 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
      • General
        • Net Promoter Score (NPS) survey
      • Webdav Integration
      • Rate Limiter
      • WebRTC
    • Engagement Dashboard
    • Device Management
    • Advanced Admin Settings
      • Authentication
        • OpenID Connect
          • Gluu Server 4.0
          • Keycloak
          • Okta Identity Cloud Service
        • iframe based Single Sign On
      • Google Cloud Features
        • Google Auto Translate
      • Managing Settings Using Environment Variables
      • Client Compatibility Matrix
      • Notifications
      • Database Migration
      • Restoring an Admin User
      • CDN
      • Troubleshooting
• Omnichannel
  • Current Chats
  • Analytics
  • Real-time Monitoring
  • Managers
  • Agents
  • Departments
  • Custom Fields
  • Livechat Triggers Manager's Guide
  • Livechat Widget Installation
    • Troubleshoot Livechat Widget Installation
  • Livechat Widget Appearance
  • Webhooks Manager's Guide
  • Facebook Messenger Manager's Guide
  • Business Hours Manager's Guide
  • Monitors Omnichannel Guide
  • Units Manager's Guide
  • Canned Responses
    • Canned Responses Rocket.Chat Admin's Guides
    • Canned Responses Omnichannel Manager's Guide
      • Manager create canned response from within chatroom
  • Tags Manager's Guide
  • Priorities Manager's Guide
  • Omnichannel Agent's Guides
    • Omnichannel Chat
      • Omnichannel Chat Quick Actions
      • Room Information
      • Canned Responses Agent's Guide
        • Agent creation of canned response from chatroom
        • Create canned response from a message
      • Search Messages in Omnichannel Conversation
      • Omnichannel Contact Information
    • Livechat Video/Audio Call Agent's Guide
    • Omnichannel Contact Center
      • Omnichannel Contact Manager
    • Omnichannel Queue
• Message Auditing Panel
  • 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 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
• App Guides
  • App Storage Location
  • Omnichannel Apps
    • SMS
    • Email Inboxes
      • Email Inbox Admin Guide
      • Email Inbox Agent Guide
    • Telegram App
      • Telegram App Installation
      • Telegram App Configuration
        • Generate your Telegram Bot Token
        • Delete Telegram App
      • Telegram App Agent's Guide
    • Rasa App
      • Rasa App Installation
      • Rasa App Configuration
        • Delete Rasa App
    • Salesforce CRM Integration
      • Salesforce CRM Installation
      • Salesforce CRM Configuration
        • Delete Salesforce CRM Integration
      • Salesforce CRM Agent's Guide
    • HubSpot CRM
      • HubSpot Installation
      • HubSpot Configuration
      • HubSpot CRM Agent's Guide
    • Dialogflow App
      • Dialogflow App Installation
      • Dialogflow App Configuration
        • Bot User Configuration
        • Upload File To Ongoing Dialogflow Chats
        • Delete Dialogflow App
    • Twitter App
      • Twitter App Installation
      • Twitter App Configuration
        • Twitter App Authentication
        • Delete Twitter App
      • Twitter App Agent's Guide
    • Facebook App
      • Facebook App Installation
      • Facebook App Configuration
        • Facebook App Authentication
        • Delete Facebook App
      • Facebook App Agent's Guide
    • WhatsApp
      • WhatsApp Installation
      • WhatsApp Configuration
        • WhatsApp Omnichannel Setup
          • Create 360Dialog Account
          • Connect WhatsApp Number to your Workspace
          • WhatsApp Set up With 360Dialog Account
        • Delete Whatsapp
      • WhatsApp Agent's Guide
    • WhatsApp Sandbox
      • WhatsApp Sandbox Installation
      • WhatsApp Sandbox Configuration
        • Delete Whatsapp Sandbox
      • WhatsApp Sandbox Agent's Guide
    • Instagram Direct
      • Instagram Direct Installation
      • Instagram Direct Configuration
        • Instagram Direct Authentication
        • Delete Instagram Direct
      • Instagram Direct Agent's Guide
    • WhatsApp Cloud App
      • WhatsApp Cloud App Install
      • Facebook Developer Account with WhatsApp
      • WhatsApp Cloud App Configuration
      • Using WhatsApp Cloud App
  • Data Loss Prevention (DLP) App Admin Guide
  • Poll
  • Poll Plus
    • Quickstart
    • Configuration
    • Guides
      • Mixed Visibility Polls
      • Word Cloud
      • User Defined Options
      • Template Based Poll
      • Live Poll
  • Atlassian
    • Jira Server v2.0
    • Bamboo
    • Bitbucket Server
    • Confluence Server
    • Jira Server
  • Zoom
  • Google Calendar
    • Google Calendar App Setup
    • Authorize and Connect with Google Calendar App
    • Google Calendar App Settings and Events
  • Trello
  • Google Drive
    • Google Drive App Setup
    • Authorize and Connect with Google Drive App
    • Google Drive App File Actions
• Mobile Guides
  • Push Notifications
    • Push Notifications User Guide
    • Secured Push Notification
    • Mobile Device Settings
  • Default Browser Settings
• Roles in Rocket.Chat
  • Marketplace Roles
• Security and Compliance Guides
  • Compliance Resources and Certifications
  • Security fixes and updates
    • cve-2022-32211
  • End-to-End Encryption Specifications
• Brand and Visual Guidelines
  • Logo
  • Typography
  • Colors
  • Patterns
  • Iconography
  • Photos
  • Brand Usage Examples
  • Media Kit
• Enterprise Edition Trial
  • Have a Workspace
  • Do not have a Workspace
  • Extending Trial

Rocket.Chat SaaS

• Rocket.Chat Cloud
  • Create your new cloud account
  • Manage your cloud account
    • Custom domain for your Cloud-hosted workspace
    • Profile
    • Organization Settings
    • Workspaces
      • Restart Workspace
      • Cancel Workspace
      • Update Workspace
      • Workspace Information
      • Upgrade/Downgrade your Plan
    • Invoices
    • Payment Methods
    • Support
    • Contact Sales
  • Cloud Account Setup Wizard

Air-gapped Workspaces

• Air-gapped Deployment
• Offline Workspace Registration
• Offline License
• Air-gapped workspace Configuration
• Manual App Installation

Resources

• Frequently Asked Questions
  • Update FAQs
  • Cloud FAQs
  • Support FAQs
  • Whatsapp Business App FAQs
  • Identity Management EE FAQ
  • Omnichannel FAQs

Contributors

• How can I help?
  • Bug Reporting
  • Developing
  • Documenting
    • New Feature Template
    • Feature Change Template
    • Markdown Style Guide
  • Promoting
  • Security
    • Responsible Disclosure Policy
  • Translating
  • Donate
• Contributor Code of Conduct
• Annual Contribution Programs
  • Google Summer of Code
    • Google Summer of Code 2022
    • Google Summer of Code 2021
    • Google Summer of Code 2020
    • Google Summer of Code 2019
    • Google Summer of Code 2018
    • Google Summer of Code 2017
  • Google Season of Docs
    • Google Season of Docs 2022
    • Google Season of Docs 2021
    • Google Season of Docs 2019

---

• Github Sponsorship

Legal

• Terms of Service
• Master Services Agreement for Self Managed Workspaces
• Master Service Agreement for Professional Services
• Privacy Policy
  • Data Processing Agreement
  • Subprocessors
• Privacy Policy Facebook Messenger
• Code of Conduct for our services
• GDPR
• Censorship and Harmful Content
• Guidelines for Law Enforcement
• Server Lookup
• DMCA Policy