Welcome

Documentation Status Map

This is a map of all of the Rocket.Chat Documentation articles

Here you can also find what articles are incomplete and missing.

Red Colored Text means that this article is missing from the documentation and need to be added.

Orange Colored Text means that this article is in the documentation but is incomplete or outdated.

  • Contributing
    • Developing
    • Google Summer of Code
    • Promoting
    • Reporting Issues
    • Security:
      • Responsible Disclosure Policy
    • Translating
  • Getting Support
  • Installation:
    • Rocket.Chat Cloud
    • PaaS Deployments:
      • Aliyun
      • AWS
      • Cloudron.io
      • Digital Ocean
      • DPlatform
      • Galaxy
      • Google Computer Engine
      • Heroku
      • Hyper.sh
      • IBM Bluemix
      • IndieHosters
      • Koozali
      • Layershift
      • OpenShift
      • ReadySpace
      • Sandstorm.io
      • Scalingo
      • Sloppy.io
      • WeDeploy
    • Docker containers:
      • Generic Linux
      • systemd
      • High Availability Install
      • Available Images
      • Docker Compose
    • Manual Installation:
      • CentOS
      • Debian
      • MacOSX
      • Multiple Instances to Improve Performance
      • Migrating Meteor Mongo
      • OpenSUSE
      • RedHat
      • Ubuntu:
        • Snaps:
          • AutoSSl
      • Mongo Options
      • Configuring SSL Reverse Proxy
      • PM2, Systemd, Upstart
      • Running in a sub folder
    • Automation tools:
      • Ansible
      • Openshift
      • Vagrant
    • Mobile and Desktop Apps
    • Updating
      • From 0.x.x to 0.40.0
    • Minimum Requirements
    • Community Supported Install:
      • FreeBSD
        • Universal
      • Windows 10 Pro
      • Windows Server:
  • User guides:
    • Connecting to a Server
    • Registration
    • Login
    • Channels
    • Messaging
    • Channel Actions
    • Managing your Account
    • Voice and Video Calls
  • Administrator guides:
  • Developer guides:
    • Quick Start
    • Branches and Releases
    • Code Styleguide:
    • Deeplink
    • Deprecation
    • Iframe Integration:
    • Embedded Layout
    • Internationalization
    • Livechat API
    • Mobile Apps
      • Supporting SSL
      • Supported Servers Versions
    • Realtime-API:
      • Method Calls:
        • Login
        • Logout
        • Register User
        • Get User Roles
        • List Custom Emoji
        • Load History
        • Get Room Roles
        • Get Subscriptions
        • Get Rooms
        • Get Public Settings
        • Get Permissions
        • User Presence
        • Notify Room Stream
        • Create Direct Message
        • Send Message
        • Delete Message
        • Update Message
        • Pin Message
        • Unpin Message
        • Set Reaction
        • Create Channels
        • Create Private Groups
        • Delete Rooms
        • Archive Rooms
        • Unarchive Rooms
        • Joining Channels
        • Leaving Rooms
        • Hiding Rooms
        • Opening Rooms
        • Favoriting Rooms
        • Save Room Settings
      • Subscriptions:
        • Stream Notify All
        • Stream Notify User
        • Stream Notify Room
        • Stream Room Messages
      • The Message Object
      • The Room Object
      • Livechat API:
        • getInitialData
        • registerGuest
        • sendMessageLivechat
        • sendOfflineMessage
      • Rest API:
      • Assets:
        • setAsset
        • unsetAsset
      • Authentication:
        • facebook
        • forgotPassword
        • google
        • login
        • logout
        • me
        • twitter
      • Channels:
        • addAll
        • addModerator
        • addOwner
        • archive
        • close
        • counters
        • create
        • delete
        • files
        • getAllUserMentionsByChannel
        • getIntegrations
        • history
        • info
        • invite
        • kick
        • leave
        • list.joined
        • list
        • members
        • moderators
        • open
        • removeModerator
        • removeOwner
        • rename
        • roles
        • setAnnouncement
        • setCustomFields
        • setDefault
        • 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
        • delete
        • files
        • getIntegrations
        • history
        • info
        • invite
        • kick
        • leave
        • list
        • listAll
        • moderators
        • members
        • open
        • removeModerator
        • removeOwner
        • rename
        • roles
        • setAnnouncement
        • setCustomFields
        • setDescription
        • setPurpose
        • setReadOnly
        • SetTopic
        • setType
        • unarchive
      • Im:
        • close
        • counters
        • create
        • files
        • history
        • list.everyone
        • list
        • members
        • messages.others
        • open
        • setTopic
      • Integration:
        • create
        • history
        • list
        • remove
      • Livechat:
        • department
        • sms-incoming
        • users
      • Miscellaneous:
        • directory
        • info
        • shield.svg
        • spotlight
        • statistics
        • statistics.list
      • Permissions:
        • list
        • update
      • Roles:
        • create
        • list
        • addUserToRole
      • Push:
        • push.token
        • deletePushToken
      • Rooms:
        • cleanHistory
        • favorite
        • get
        • saveNotification
        • upload
      • Settings:
        • get
        • update
        • oauth
      • Subscriptions:
        • get
        • getOne
        • read
        • unread
      • Users:
        • create
        • createToken
        • delete
        • deleteOwnAccount
        • forgotPassword
        • generatePersonalAccessToken
        • getAvatar
        • getPersonalAccessTokens
        • getPresence
        • get-preferences
        • getUsernameSuggestion
        • info
        • list
        • regeneratePersonalAccessToken
        • register
        • removePersonalAccessToken
        • resetAvatar
        • setAvatar
        • set-preferences
        • update
        • updateOwnBasicInfo
      • Offset and Count and Sort Info
      • Query and Fields Info
      • Personal Access Tokens
      • Schema Definition
      • Testing
      • Troubleshooting
      • UI and Theming:
      • Colors
      • Components
      • Themes
  • Bots:
    • Bots FAQ
    • Bots Architecture
    • Creating Bot Users
    • Configure Bot Environment
    • Running a bBot Bot
    • Running a Hubot Bot
    • Running a Botkit Bot
    • Running a Rasa Bot
    • Running a Botpress Bot
  • Community Cookbook:
    • Remote Video Monitoring