SUMMARY.md

Table of contents

• Rocket.Chat

Deploy

• Prepare for your Deployment
  • Choosing a Deployment Method
  • Hardware Requirements
  • Cloud Deployments
    • AWS
    • Google Compute Engine
    • IBM Cloud
    • DigitalOcean
  • 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
  • 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
      • Running Multiple Instances
    • 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
  • Starting & Stopping Docker Compose
• Scaling Rocket.Chat
  • Microservices
  • Automation Tools
    • Ansible
    • OpenShift
    • Vagrant
• Installing Client Apps
  • Rocket.Chat Desktop & Mobile Apps
  • Minimum Requirements
• 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
• Updating Rocket.Chat
  • Updating FAQ

Setup and Configure

• 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 Cloud Features
  • Managing Settings Using Environmental Variables
  • Identity Management (EE vs CE)
  • Notifications
  • Database Migration
  • Restoring an Admin User
  • CDN
  • Troubleshooting
  • Client Compatibility Matrix
• Enterprise Edition Trial
  • Have a Workspace
  • Do not have a Workspace
  • Extending Trial
• Rocket.Chat Air-gapped Deployment
  • Offline Workspace Registration
  • Offline License
  • Air-gapped workspace Configuration
  • Air-gapped App Installation
• Roles in Rocket.Chat
  • Marketplace Roles

Use Rocket.Chat

• User Guides
  • Access your workspace
  • User Panel
    • My Account
      • Manage Devices
  • Rooms
    • Channels
      • Create a new Channel
      • Edit A Channel
      • Manage Channel Members
      • Channel LiveStream
      • 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
  • Messages
    • Message Actions
    • Off-the-record (OTR) Messaging User Guide
  • 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
  • Info
  • Import
    • Import from HipChat
    • Import from Slack
      • SlackBridge
    • Import CSV
  • Users
    • Guest users
    • Add users through Identity management and authentication services
  • Rooms
  • Invites
  • Connectivity Services
  • View Logs
  • Federation Dashboard
  • 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
  • User Status
  • Permissions
  • 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
          • Assign roles for users in federated rooms
        • Matrix Bridge FAQs
      • Rocket.Chat Federation
        • Cross-server Federated Channels
    • File Upload
      • Minio
      • Recommendations for File Upload
      • File Upload FAQs
    • General
      • Net Promoter Score (NPS) survey
    • IRC
    • IRC Federation
    • Layout
    • LDAP
      • LDAP Connection Setting
      • LDAP User Search
      • LDAP Data Sync Settings
      • LDAP Enterprise Settings
      • LDAP Examples
    • Livestream & Broadcasting
    • Logs
    • Message
    • Meta
    • Mobile
    • OAuth
      • Facebook OAuth Setup
      • Google OAuth Setup
      • GitLab OAuth Setup
      • GitHub 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
    • 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
    • Webdav Integration
    • WebRTC
  • Engagement Dashboard
  • Device Management
• Omnichannel
  • Current Chats
  • Analytics
  • Real-time Monitoring
  • Managers
  • Agents
  • Departments
  • Custom Fields
  • Livechat Triggers
  • Livechat Widget Installation
  • Livechat Widget Appearance
  • Webhooks
  • Facebook Messenger Manager's Guide
  • 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
  • Cross-server Federated Channels
• 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 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
          • Create Permanent WhatsApp Cloud API Token
        • WhatsApp Cloud App Configuration
        • Using WhatsApp Cloud App
    • Atlassian
      • Jira Server v2.0
      • Bamboo
      • Bitbucket Server
      • Confluence Server
      • Jira Server
    • Pexip App
    • Jitsi app
    • BigBlueButton (BBB) app
    • Google Meet app
    • Trello
      • Using the Trello App
    • Zoom
    • Data Loss Prevention (DLP) App
    • Poll
    • Poll Plus
      • Poll Plus Features
    • 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
  • App Storage Location
• Integrations
• Rocket.Chat API

Resources

• Frequently Asked Questions
  • Apps FAQs
  • Update FAQs
  • WhatsApp Cloud API FAQs
  • Cloud FAQs
  • Support FAQs
  • Whatsapp Business App FAQs
  • Identity Management EE FAQ
  • Omnichannel FAQs
• Brand and Visual Guidelines
  • Logo
  • Typography
  • Colors
  • Patterns
  • Iconography
  • Photos
  • Brand Usage Examples
  • Media Kit
• Development Docs
• Get Support
  • Enterprise Support
    • Enterprise Support Plans
  • Community Resources
  • Legacy Support

Contribute to Rocket.Chat

• Contributor Code of Conduct
• How can I help?
  • Bug Reporting
  • Developing
  • Documenting
    • New Feature Template
    • Feature Change Template
    • Markdown Style Guide
  • Promoting
  • Security
    • Responsible Disclosure Policy
  • Translating
  • Donate
• Annual Contribution Programs
  • Google Summer of Code
    • Google Summer of Code 2023
    • 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 2023
    • Google Season of Docs 2022
    • Google Season of Docs 2021
    • Google Season of Docs 2019
• Github Sponsorship

Rocket.Chat Legal

• Terms of Service
• Master Services Agreement for Self Managed Workspaces
• Master Service Agreement for Professional Services
• Code of Conduct for our services
• Censorship and Harmful Content
• Guidelines for Law Enforcement
• Server Lookup
• DMCA Policy

Rocket.Chat privacy and security

• Privacy Policies
  • Rocket.Chat Privacy Policy
    • Subprocessors
  • Privacy Policy Facebook Messenger
• Security Policy
• Security and Compliance Guides
  • Compliance Resources and Certifications
  • Security fixes and updates
    • cve-2022-32211
  • End-to-End Encryption Specifications
• Data Processing Agreement
• GDPR