File

mod_portcheck/README.md @ 6052:451ec67f2dd3

mod_s2s_idle_timeout: Reword README 'HG:' are removed. HG: Leave message empty to abort commit. HG: -- HG: user: Menel <menel@snikket.de> mod_s2s_idle_timeout/README.md
author Menel <menel@snikket.de>
date Mon, 11 Nov 2024 23:19:33 +0100
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.