mod_portcheck/README.md
author Kim Alvefur <zash@zash.se>
Sat, 30 Mar 2024 15:10:51 +0100
changeset 5881 70fa3f8de249
parent 4901 42a362a2bf51
permissions -rw-r--r--
mod_sasl2_fast: Update reference to now published XEP-0484 (thanks gooya)

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.