Mercurial > prosody-modules
view mod_muc_badge/README.markdown @ 3336:4af114684e0a
mod_http_index: Allow listed modules to include a friendlier name
Example:
```
module:provides("http", {
name = "demo";
title = "Demo HTTP Module";
route = {
GET = function() return "Hello"; end;
};
});
```
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Thu, 27 Sep 2018 17:13:10 +0200 |
| parents | a646fcb45334 |
| children |
line wrap: on
line source
--- depends: - 'mod\_http' - 'mod\_muc' provides: - http title: 'mod\_muc\_badge' --- # Introduction This module generates a badge for MUC rooms at a HTTP URL like `https://conference.example.com:5281/muc_badge/room@conference.example.org` containing the number of occupants. Inspiration : <https://opkode.com/blog/xmpp-chat-badge/> # Configuration Option Type Default ------------------ -------- -------------------------- `badge_count` string `"%d online"` `badge_template` string A SVG image (see source) The template must be valid XML. If it contains `{label}` then this is replaced by `badge_label`, similarly, `{count}` is substituted by `badge_count` with `%d` changed to the number of occupants. Details of the HTTP URL is determined by [standard Prosody HTTP server configuration][doc:http]. # Example ```lua Component "conference.example.com" "muc" modules_enabled = { "muc_badge" } ```