index.md

MongooseIM Documentation

• Home: https://github.com/esl/MongooseIM
• Product page: https://www.erlang-solutions.com/products/mongooseim.html
• Documentation: https://esl.github.io/MongooseDocs/
• Try it now: https://trymongoose.im

Get to know MongooseIM

MongooseIM is a robust, scalable and efficient XMPP server at the core of an Instant Messaging platform aimed at large installations.

Designed for enterprise, it is fault-tolerant, can utilise the resources of multiple clustered machines, and easily scales for more capacity by simply adding a box or a VM.

MongooseIM can accept client sessions over vanilla XMPP, GraphQL API, REST API and SSE, as well as Websockets and BOSH (HTTP long-polling).

As a platform, MongooseIM includes several server-side (backend) and client-side (frontend) components. We provide a test suite, metrics, a load testing platform, and a monitoring server. We recommend third-party, open source client libraries for XMPP, GraphQL API and REST API.

MongooseIM is brought to you by Erlang Solutions.

MongooseIM platform components

Server-side components

We offer a set of additional server-side components:

• WombatOAM is a powerful monitoring platform that comes with a dedicated MongooseIM plugin
• Test suite is written with the help of these useful tools:
  • escalus: an XMPP client for Erlang
  • amoc: a load testing tool
• MongooseICE: is a STUN and TURN server written for traversing NATs and relaying streams
• MongoosePush: is a flexible push notification server with APNS and FCM support

Client-side components

• XMPP client libraries - we recommend the following client libraries:
  • iOS, Objective-C: XMPPFramework
  • Android, Java: Smack
  • Web, JavaScript: Stanza.io, Strophe.js
• REST API client libraries - we recommend the following client libraries:
  • iOS, Swift: Jayme
  • Android, Java: Retrofit

Download packages

For a quick start just download:

• The pre-built packages that suit your platform (Ubuntu, Debian, CentOS compatible: AlmaLinux and Rocky Linux)
• The Docker image (source code repository)
• The Helm chart (source code repository)

See the installation guide for more details.

Public testing

Check out our test results:

• CI testing:
  • GH Actions
  • CircleCI
• Code coverage:
  • Codecov - reported by CircleCI.
  • Coveralls - reported by GH Actions.

Versions

See the documentation for the latest releases:

• Master
• 6.3.0
• 6.2.1
• 6.2.0
• 6.1.0
• 6.0.0
• 5.1.0
• 5.0.0
• 4.2.0
• 4.1.0
• 4.0.1
• 3.7.1
• 3.6.2
• 3.5.0
• 3.4.1
• 3.3.0
• 3.2.0
• 3.1.1
• 3.0.1

Participate!

Suggestions, questions, thoughts? Contact us directly:

• Raise a GitHub issue
• Email us at [email protected]
• Follow our Twitter account