Mercurial > prosody-modules
view mod_portcheck/README.md @ 5734:cef8bce2d71b
luacheck: Add new module API methods from trunk
See
* trunk rev 4d4f9e42bcf8
* trunk rev 65fb0d7a2312
* trunk rev c9ef35fab0b1
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Mon, 27 Nov 2023 07:10:06 +0100 |
parents | 42a362a2bf51 |
children |
line wrap: on
line source
This module adds a `portcheck` command to the [shell][doc:console] intended for use with health checks, i.e. to check whether Prosody is listening to all expected ports. # Usage After installing and enabling the module a command like this becomes available: ``` bash prosodyctl shell "portcheck [::]:5222 *:5222 [::]:5269 *:5269" ``` This would check if the c2s (`5222`) and s2s (`5269`) ports are available on both IPv6 (`*`) and *Legacy IP*^[often referred to as IPv4]. # Compatibility Compatible with Prosody **trunk**, will **not** work with 0.11.x or earlier.