Mercurial > prosody-modules

annotate mod_extdisco/README.md @ 6556:7477e97a9045

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_firewall: Apply pre-reload state before re-reading config This change makes load/reload a bit more robust. module.load() runs before module.restore() and it reads from the config and updates the state (if needed). However, after this, module.restore() could run and apply the old state again.
author Matthew Wild <mwild1@gmail.com>
date Sun, 24 May 2026 20:03:20 +0100
parents 8d75d5f82a83
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1889
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 ---
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 summary: External Service Discovery
6459
8d75d5f82a83 mod_extdisco/README.md: mark as superseded
Menel <menel@snikket.de>
parents: 5975
diff changeset
3 superseded_by: mod_external_services
8d75d5f82a83 mod_extdisco/README.md: mark as superseded
Menel <menel@snikket.de>
parents: 5975
diff changeset
4 labels:
8d75d5f82a83 mod_extdisco/README.md: mark as superseded
Menel <menel@snikket.de>
parents: 5975
diff changeset
5 - 'Stage-Obsolete'
1889
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 ...
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7
6459
8d75d5f82a83 mod_extdisco/README.md: mark as superseded
Menel <menel@snikket.de>
parents: 5975
diff changeset
8
8d75d5f82a83 mod_extdisco/README.md: mark as superseded
Menel <menel@snikket.de>
parents: 5975
diff changeset
9 ::: {.alert .alert-warning}
8d75d5f82a83 mod_extdisco/README.md: mark as superseded
Menel <menel@snikket.de>
parents: 5975
diff changeset
10 This module is obsolete, please use [mod_external_services] (nearly exact replacement)
8d75d5f82a83 mod_extdisco/README.md: mark as superseded
Menel <menel@snikket.de>
parents: 5975
diff changeset
11 or [mod_turn_external] (narrow scope for turn), both included in prosody.
8d75d5f82a83 mod_extdisco/README.md: mark as superseded
Menel <menel@snikket.de>
parents: 5975
diff changeset
12 :::
8d75d5f82a83 mod_extdisco/README.md: mark as superseded
Menel <menel@snikket.de>
parents: 5975
diff changeset
13
1889
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 Introduction
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 ============
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 This module adds support for [XEP-0215: External Service Discovery],
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 which lets Prosody advertise non-XMPP services.
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 Configuration
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 =============
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23 Example services from the XEP:
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 ``` {.lua}
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 modules_enabled = {
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27 -- other modules ...
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28 "extdisco";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29 }
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31 external_services = {
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
32 ["stun.shakespeare.lit"] = {
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
33 port="9998";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
34 transport="udp";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
35 type="stun";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
36 };
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
37 ["relay.shakespeare.lit"] = {
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
38 password="jj929jkj5sadjfj93v3n";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
39 port="9999";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
40 transport="udp";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
41 type="turn";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
42 username="nb78932lkjlskjfdb7g8";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
43 };
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
44 ["192.0.2.1"] = {
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
45 port="8888";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
46 transport="udp";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
47 type="stun";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
48 };
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
49 ["192.0.2.1"] = {
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
50 port="8889";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
51 password="93jn3bakj9s832lrjbbz";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
52 transport="udp";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
53 type="turn";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
54 username="auu98sjl2wk3e9fjdsl7";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
55 };
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
56 ["ftp.shakespeare.lit"] = {
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
57 name="Shakespearean File Server";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
58 password="guest";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
59 port="20";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
60 transport="tcp";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
61 type="ftp";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
62 username="guest";
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
63 };
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
64 }
46c49cff1023 mod_extdisco: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
65 ```
4020
4b47c8eeca22 mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents: 1889
diff changeset
66
4b47c8eeca22 mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents: 1889
diff changeset
67 Compatibility
4b47c8eeca22 mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents: 1889
diff changeset
68 =============
4b47c8eeca22 mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents: 1889
diff changeset
69
4b47c8eeca22 mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents: 1889
diff changeset
70 Incompatible with
4b47c8eeca22 mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents: 1889
diff changeset
71 [mod_turncredentials](https://modules.prosody.im/mod_turncredentials).