Home

Important notice - documentation moved to the repo

The whole documentation was moved from github's wiki to the main repository with source code. This was done in order to keep the documentation more up-to-date. We also use readthedocs.org to host documentation for versions of MongooseIM starting from 1.5.1. You can also go to the doc directory in our repo.

Content below will remain here but will no longer be updated.

Contents

• Get to know MongooseIM contains the overview of our application, its architecture and deployment strategies.

• Getting started is a step-by-step guide on how to:

  • Build MongooseIM on a supported OS
  • Perform basic configuration
  • Use the main administration script, mongooseimctl

• Configuration

  • Basic configuration
  • Advanced configuration
    • Listener modules
    • Extension modules
    • HTTP authentication module
  • Reloading configuration on a running system

• Clustering

  • Cluster configuration and node management
  • Logging & monitoring

• Introduction to Hooks and Handlers is worth reading if you are interested in writing your own modules. It contains the following:

  • A description of the hooks and handlers mechanism used in MongooseIM and ejabberd to call functions and pass data between various modules
  • The most useful hooks
  • An example module registering some handlers as well as creating a custom hook
  • A list of all the available hooks (and a script to extract it from the source of your version of MIM/ejabberd)

• Folsom Metrics provides an overview of the API and data format used by MongooseIM's REST metrics interface.

• Contribution