Software / code / prosody-modules
Annotate
mod_extdisco/README.md @ 6112:4c0e3fe57e92
mod_compliance_latest: Gracefull error logging on missing dependency.
diff --git a/mod_compliance_latest/README.md b/mod_compliance_latest/README.md
--- a/mod_compliance_latest/README.md
+++ b/mod_compliance_latest/README.md
@@ -9,13 +9,15 @@ rockspec:
# Introduction
-This module will always require and load to the lastest compliance tester we have in the community modules.
-Currently this is [mod_compliance_2023].
+This meta-module will always `require` (and therefore auto-load) the lastest compliance tester we have in the community modules.
+Currently this is [mod_compliance_2023]. See the linked module for further details.
+
+If you do not use the *Prosody plugin installer* this module will likely have limited value to you.
+You can also just install the current compliance tester manually.
# Configuration
-Just load this module as any other module and it will automatically install [mod_compliance_2023] if you use the Prosody plugin installer.
-See the linked module for further details.
+Just load this module as any other module and it will automatically install and load [mod_compliance_2023] if you use the *Prosody plugin installer*.
# Compatibility
diff --git a/mod_compliance_latest/mod_compliance_latest.lua b/mod_compliance_latest/mod_compliance_latest.lua
--- a/mod_compliance_latest/mod_compliance_latest.lua
+++ b/mod_compliance_latest/mod_compliance_latest.lua
@@ -1,1 +1,6 @@
-module:depends("compliance_2023");
+local success, err = pcall(function() module:depends("compliance_2023") end)
+
+if not success then
+ module:log("error", "Error, can't load module: mod_compliance_2023. Is this module downloaded in a folder readable by prosody?")
+ return 1, "Error: Couldn't load dependency mod_compliance_2023."
+end
| author | Menel <menel@snikket.de> |
|---|---|
| date | Mon, 23 Dec 2024 12:58:03 +0100 |
| parent | 6003:fe081789f7b5 |
| rev | line source |
|---|---|
| 1889 | 1 --- |
| 2 summary: External Service Discovery | |
| 3 ... | |
| 4 | |
| 5 Introduction | |
| 6 ============ | |
| 7 | |
| 8 This module adds support for [XEP-0215: External Service Discovery], | |
| 9 which lets Prosody advertise non-XMPP services. | |
| 10 | |
| 11 Configuration | |
| 12 ============= | |
| 13 | |
| 14 Example services from the XEP: | |
| 15 | |
| 16 ``` {.lua} | |
| 17 modules_enabled = { | |
| 18 -- other modules ... | |
| 19 "extdisco"; | |
| 20 } | |
| 21 | |
| 22 external_services = { | |
| 23 ["stun.shakespeare.lit"] = { | |
| 24 port="9998"; | |
| 25 transport="udp"; | |
| 26 type="stun"; | |
| 27 }; | |
| 28 ["relay.shakespeare.lit"] = { | |
| 29 password="jj929jkj5sadjfj93v3n"; | |
| 30 port="9999"; | |
| 31 transport="udp"; | |
| 32 type="turn"; | |
| 33 username="nb78932lkjlskjfdb7g8"; | |
| 34 }; | |
| 35 ["192.0.2.1"] = { | |
| 36 port="8888"; | |
| 37 transport="udp"; | |
| 38 type="stun"; | |
| 39 }; | |
| 40 ["192.0.2.1"] = { | |
| 41 port="8889"; | |
| 42 password="93jn3bakj9s832lrjbbz"; | |
| 43 transport="udp"; | |
| 44 type="turn"; | |
| 45 username="auu98sjl2wk3e9fjdsl7"; | |
| 46 }; | |
| 47 ["ftp.shakespeare.lit"] = { | |
| 48 name="Shakespearean File Server"; | |
| 49 password="guest"; | |
| 50 port="20"; | |
| 51 transport="tcp"; | |
| 52 type="ftp"; | |
| 53 username="guest"; | |
| 54 }; | |
| 55 } | |
| 56 ``` | |
|
4020
4b47c8eeca22
mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents:
1889
diff
changeset
|
57 |
|
4b47c8eeca22
mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents:
1889
diff
changeset
|
58 Compatibility |
|
4b47c8eeca22
mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents:
1889
diff
changeset
|
59 ============= |
|
4b47c8eeca22
mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents:
1889
diff
changeset
|
60 |
|
4b47c8eeca22
mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents:
1889
diff
changeset
|
61 Incompatible with |
|
4b47c8eeca22
mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents:
1889
diff
changeset
|
62 [mod_turncredentials](https://modules.prosody.im/mod_turncredentials). |