prosody-modules
4ae051999194
mod_server_contact_info/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Annotate

mod_server_contact_info/README.md @ 6294:4ae051999194

mod_flags: Add short stub README with link to Prosody docs
author Kim Alvefur <zash@zash.se>
date Sun, 08 Jun 2025 13:36:40 +0200
parent 5948:254a21a104aa
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5948
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
1 ---
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
2 labels:
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
3 - 'Stage-Alpha'
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
4 summary: Backported mod_server_contact_info for Prosody 0.12
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
5 ...
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
6
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
7 ## Overview
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
8
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
9 In February 2024 we improved the internal API to allow multiple modules to
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
10 publish information about the server, this includes mod_pubsub_serverinfo.
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
11
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
12 Although Prosody 0.12 comes with its own mod_server_contact_info, this version
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
13 uses the new API so that 0.12 users can hopefully use mod_pubsub_serverinfo
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
14 and other modules which use the new API.
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
15
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
16 To use it, you must ensure that your Prosody 0.12 deployment is loading *both*
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
17 mod_server_contact_info **and** mod_server_info community modules.
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
18
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
19 Configuration of contact addresses is the same, whatever version of the module
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
20 you use. See the official documentation on [Prosody's mod_server_contact_info](https://prosody.im/doc/modules/mod_server_contact_info)
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
21 page.
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
22
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
23 ## Compatibility
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
24
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
25 This module should be compatible with Prosody 0.12, and will fail to load in
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
26 later versions (which already provide the same functionality without community
254a21a104aa mod_server_contact_info: Backport from prosody trunk
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
27 modules).