Welcome

Contributing
Getting Support
Installation
User guides
Administrator guides
- Account Settings
- Authentication
  - CAS
  - Ldap
  - Oauth
  - SAML
    - Oracle Cloud
  - WordPress
- Database-Migration
- Email
- File Upload
- Import
  - CSV
  - HipChat
    - Cloud
    - Enterprise
  - Slack
    - SlackBridge
- Integrations
  - Zapier
    - Using Zaps
  - AppVeyor
  - Azure Alerts
  - BitBucket
  - DeadSimpleScreenSharing
  - Giphy
  - GitHub
  - GitLab
  - Google-Calendar
  - Guggy
  - Jenkins
  - Jira
  - NewRelic
  - nixstats
  - Osticket
  - PagerDuty
  - Prometheus
  - ReplyGif
  - ReviewBoard
  - RunDeck
  - Sentry
  - Telegram
  - Travis CI
  - Trello
  - Uptime Robot
- Jitsi Video Bridge
- Livechat
  - Livechat Queues
- Notifications
  - Push Notifications
- Permissions
- Plug-ins
  - Drupal
  - Pidgin
- Create the First Admin
- Restoring an Admin
- Settings Via Env Vars
- Youtube Broadcasting
Developer guides
- Quick Start
- Branches and Releases
- Code Styleguide
  - less
- Deeplink
- Deprecation
- Iframe Integration
- Embedded Layout
- Internationalization
- Livechat API
- Mobile Apps
  - Supporting SSL
  - Supported Servers Versions
- Realtime-API
- Rest API
  - Authentication
    - facebook
    - google
    - login
    - logout
    - me
    - twitter
  - Channels
    - addAll
    - addModerator
    - addOwner
    - archive
    - close
    - counters
    - create
    - files
    - getAllUserMentionsByChannel
    - getIntegrations
    - history
    - info
    - invite
    - kick
    - leave
    - list.joined
    - list
    - open
    - removeModerator
    - removeOwner
    - rename
    - setCustomFields
    - setDescription
    - setJoinCode
    - setPurpose
    - setReadOnly
    - SetTopic
    - setType
    - unarchive
  - Chat
    - delete
    - getMessage
    - getMessageReadReceipts
    - pinMessage
    - postMessage
    - react
    - reportMessage
    - search
    - starMessage
    - sendMessage
    - unPinMessage
    - unStarMessage
    - update
  - Commands
    - get
    - list
    - run
  - Groups
    - addAll
    - addModerator
    - addOwner
    - archive
    - close
    - counters
    - create
    - files
    - getIntegrations
    - history
    - info
    - invite
    - kick
    - leave
    - list
    - listAll
    - open
    - removeModerator
    - removeOwner
    - rename
    - setCustomFields
    - setDescription
    - setPurpose
    - setReadOnly
    - SetTopic
    - setType
    - unarchive
  - Im
    - close
    - counters
    - create
    - files
    - history
    - list.everyone
    - list
    - messages.others
    - open
    - setTopic
  - Integration
    - create
    - list
    - remove
  - Livechat
  - Miscellaneous
  - Rooms
    - cleanHistory
    - favorite
    - get
    - saveNotification
    - upload
  - Settings
    - get
    - get-by-id
    - oauth
    - public
    - service-configuration
    - update
  - Subscriptions
    - get
    - getOne
    - read
    - unread
  - Users
    - create
    - createToken
    - delete
    - forgotPassword
    - getAvatar
    - getPresence
    - get-preferences
    - getUsernameSuggestion
    - info
    - list
    - register
    - resetAvatar
    - setAvatar
    - set-preferences
    - update
    - updateOwnBasicInfo
  - Offset and Count and Sort Info
  - Permissions
  - Query and Fields Info
- Schema Definition
- Testing
- Troubleshooting
- UI and Theming
  - Colors
  - Components
  - Themes
Bots
Community Cookbook
- Remote Video Monitoring

Deploying Rocket.Chat on Scalingo

Deploy your own Rocket.Chat server instantly on Scalingo

Contribute to this page on GitHub

Table of contents