Skip to content
Growing and curated ejabberd contributions repository - PR or ask to join !
Branch: master
Clone or download
weiss Import mod_default_rooms
Add a module that can be used to auto-bookmark a configured list of
rooms on registration.
Latest commit d60fa5e Feb 27, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
atom_pubsub Show more prominently notice that some modules don't work with new ej… Sep 12, 2016
ejabberd_auth_http Use p1_rand:bytes instead of crypto to work in supported Erlang versi… Nov 7, 2018
extra Remove obsolete file Apr 29, 2015
ircd Show more prominently notice that some modules don't work with new ej… Sep 12, 2016
mod_archive Show more prominently notice that some modules don't work with new ej… Sep 12, 2016
mod_cron Update modules for ejabberd 18.06 lack of jlib.hrl and ejabberd.hrl (#… Jul 13, 2018
mod_default_rooms Import mod_default_rooms Feb 27, 2019
mod_deny_omemo mod_deny_omemo: Also reject actual OMEMO messages Aug 17, 2018
mod_filter Update mod_filter to work with recent ejabberd Sep 18, 2018
mod_grafite
mod_irc mod_irc: Disable spurious vCard->WHOIS requests (thanks to Kousu)(#874) Jan 21, 2019
mod_log_chat Update to work with ejabberd 17.06 Jun 7, 2017
mod_logsession Update modules for ejabberd 18.06 lack of jlib.hrl and ejabberd.hrl (#… Jul 13, 2018
mod_logxml Use mod_opt_type and mod_options to check options values (#268) Feb 11, 2019
mod_mam_mnesia
mod_message_log mod_message_log: Update for ejabberd 18.12 Dec 10, 2018
mod_muc_log_http Update modules for ejabberd 18.06 lack of jlib.hrl and ejabberd.hrl (#… Jul 13, 2018
mod_openid Show more prominently notice that some modules don't work with new ej… Sep 12, 2016
mod_post_log Update modules for ejabberd 18.06 lack of jlib.hrl and ejabberd.hrl (#… Jul 13, 2018
mod_pottymouth Stop the bloom and normalize processes when stopping mod_pottymouth Feb 21, 2019
mod_profile
mod_rest Add example call in Curl to mod_rest Feb 11, 2019
mod_s2s_log Update modules for ejabberd 18.06 lack of jlib.hrl and ejabberd.hrl (#… Jul 13, 2018
mod_shcommands Update modules for ejabberd 18.06 lack of jlib.hrl and ejabberd.hrl (#… Jul 13, 2018
mod_statsdx Update modules for ejabberd 18.06 lack of jlib.hrl and ejabberd.hrl (#… Jul 13, 2018
mod_webpresence
.gitignore
README-broken.md Cleanup for module packaging support in ejabberd Mar 11, 2015
README.md

README.md

ejabberd-contrib

This is a collaborative development area for ejabberd module developers and users.

For users

To use an ejabberd module coming from this repository:

  • You need to have ejabberd installed.

  • If you have not already done it, run ejabberdctl modules_update_specs to retrieve the list of available modules.

  • Run ejabberdctl module_install <module> to get the source code and to compile and install the beam file into ejabberd's module search path. This path is either ~/.ejabberd-modules or defined by the CONTRIB_MODULES_PATH setting in ejabberdctl.cfg.

  • Edit the configuration file provided in the conf directory of the installed module and update it to your needs. Then apply the changes to your main ejabberd configuration. In a future release, ejabberd will automatically add this file to its runtime configuration without changes.

  • Run ejabberdctl module_uninstall <module> to remove a module from ejabberd.

For developers

The following organization has been set up for the development:

  • Development and compilation of modules is done by ejabberd. You need ejabberd installed. Use ejabberdctl module_check <module> to ensure it compiles correctly before committing your work. The sources of your module must be located in $CONTRIB_MODULES_PATH/sources/<module>.

  • Compilation can by done manually (if you know what you are doing) so you don't need ejabberd running:

    cd /path/of/module
    mkdir ebin
    /path/of/ejabberd's/erlc \
       -o ebin \
       -I include -I /path/of/ejabberd/lib/ejabberd-XX.YY/include \
       -DLAGER -DNO_EXT_LIB \
       src/*erl
    
  • The module directory structure is usually the following:

    • README.txt: Module description.
    • COPYING: License for the module.
    • doc/: Documentation directory.
    • src/: Erlang source directory.
    • lib/: Elixir source directory.
    • priv/msgs/: Directory with translation files (pot, po and msg).
    • conf/<module>.yml: Configuration for your module.
    • <module>.spec: Yaml description file for your module.
  • Module developers should note in the README.txt file whether the module has requirements or known incompatibilities with other modules.

You can’t perform that action at this time.