jacob.eva
/
ejabberd-contrib
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Growing and curated ejabberd contributions repository - PR or ask to join !
62 Commits 3 Branches 0 Tags 8.3 MiB
Erlang 98.7%
Ruby 0.9%
Elixir 0.2%
TSQL 0.2%
Go to file
badlop 72701df745 Merge pull request #36 from weiss/update-readme 
Update the main README.txt file
 		2014-05-29 11:29:25 +02:00
atom_pubsub Initial import from ejabberd-modules SVN 2013-04-15 12:03:14 +02:00
bfile Add ebin/ dirs with .keepme file to ensure Git tracks them 2013-04-15 12:18:19 +02:00
dns/src Initial import from ejabberd-modules SVN 2013-04-15 12:03:14 +02:00
ejabberd-dev Use Lager when compiling mod_rest, and include minimum in this repository (fixes #13) 2014-03-03 16:55:44 +01:00
ejabberdPrefs Initial import from ejabberd-modules SVN 2013-04-15 12:03:14 +02:00
ircd Add ebin/ dirs with .keepme file to ensure Git tracks them 2013-04-15 12:18:19 +02:00
jorge Initial import from ejabberd-modules SVN 2013-04-15 12:03:14 +02:00
mod_admin_extra Update kick_session to work with ejabberd master 2014-05-07 18:44:48 +02:00
mod_archive Add ebin/ dirs with .keepme file to ensure Git tracks them 2013-04-15 12:18:19 +02:00
mod_cron Add ebin/ dirs with .keepme file to ensure Git tracks them 2013-04-15 12:18:19 +02:00
mod_ctlextra Add ebin/ dirs with .keepme file to ensure Git tracks them 2013-04-15 12:18:19 +02:00
mod_irc Add ebin/ dirs with .keepme file to ensure Git tracks them 2013-04-15 12:18:19 +02:00
mod_log_chat Fix mod_log_chat so it works with Ejabberd 13.12. 2014-05-04 22:42:13 -05:00
mod_logsession Use the regexp frontend module (EJAB-921) 2013-09-10 18:36:39 +02:00
mod_logxml Add ebin/ dirs with .keepme file to ensure Git tracks them 2013-04-15 12:18:19 +02:00
mod_message_log Add mod_message_log module 2014-05-27 00:57:06 +02:00
mod_muc_admin mod_muc_admin: Fix "muc_online_rooms" output 2014-04-09 23:30:03 +02:00
mod_muc_log_http Add ebin/ dirs with .keepme file to ensure Git tracks them 2013-04-15 12:18:19 +02:00
mod_multicast Update mod_multicast to allow compile 2014-03-04 17:06:30 +01:00
mod_openid Use the regexp frontend module (EJAB-921) 2013-09-10 18:36:39 +02:00
mod_profile Add ebin/ dirs with .keepme file to ensure Git tracks them 2013-04-15 12:18:19 +02:00
mod_register_web Add ebin/ dirs with .keepme file to ensure Git tracks them 2013-04-15 12:18:19 +02:00
mod_rest Add support for using yaml config file. 2014-03-18 11:36:57 -05:00
mod_s2s_log mod_s2s_log: Update gen_mod:get_opt() call 2014-04-09 23:14:33 +02:00
mod_shcommands Fix mod_shcommands compilation 2013-08-07 13:31:15 +02:00
mod_statsdx Some updates to work a little more with ejaberd 13 binaryzation 2014-04-03 17:45:23 +02:00
mod_webpresence Refactor mod_webpresence to work with binary plus icons 2014-04-09 12:11:25 +02:00
openfire-export/OpenfireExporter Initial import from ejabberd-modules SVN 2013-04-15 12:03:14 +02:00
.gitignore Ignore .beam files 2014-03-14 11:47:54 -05:00
README.md Convert README to Markdown 2014-05-27 21:22:42 +02:00
extract-mod-translations.sh Initial import from ejabberd-modules SVN 2013-04-15 12:03:14 +02:00

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 Erlang installed.

  • Read the module-specific README.txt file to see if special steps are required to deploy it.

  • Run ./build.sh or build.bat in the root directory of the desired module.

  • Copy generated .beam files from the ebin directory to the directory where your ejabberd .beam files are.

  • Use the configuration file examples provided in the conf dir to update your ejabberd.cfg or ejabberd.yml configuration file.

If during compilation of a module you get an error like:

{"init terminating in do_boot",{undef,[{make,all,[]},...

it means Erlang couldn't find its make.beam file. In Debian and other distributions you can try to install packages like:

erlang-dev erlang-nox erlang-tools

For developers

The following organization has been set up for the development:

  • Development and compilation of modules should be possible without the ejabberd source code, as the ejabberd-dev helper module contains the include files necessary to make compilation possible.

  • The module directory structure is usually the following:

    • README.txt: Module description.
    • LICENSE.txt: License for the module.
    • Emakefile: Erlang Makefile to build the module (preferred way, if no dependencies on C code, as build will thus work on Windows).
    • doc/: Documentation directory.
    • src/: Source directory.
    • src/msgs/: Directory with translation files (pot, po and msg).
    • ebin/: Empty (target directory for the build).
    • conf/: Directory containing example configuration for your module.
    • build.sh: Unix/Linux build script.
    • build.bat: Windows build script.

  • Module developers should note in the README.txt file whether the module has requirements or known incompatibilities with other modules (for example, by modifying the same main ejabberd modules).