File

mod_portcheck/README.md @ 5867:79ae71f52c81

mod_pubsub_serverinfo: Update to use mod_server_info (fixes #1841) ...but only for Prosody trunk users, because 0.12 mod_server_contact_info does not use the new API in mod_server_info.
author Matthew Wild <mwild1@gmail.com>
date Fri, 23 Feb 2024 22:50:57 +0000
parent 4897:42a362a2bf51
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.