File

mod_muc_badge/README.markdown @ 3165:7af4776a5dea

mod_http_upload_external: Log file type and size
author Matthew Wild <mwild1@gmail.com>
date Mon, 02 Jul 2018 12:56:51 +0100
parent 3145:a3afab416271
child 3295:4a77c9c2a1cd
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://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_label`      string   `"Chatroom"`
  `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].

# TODO

-   Maybe use the room name instead of a fixed label. Would need dynamic
    resizing.