comparison mod_portcheck/README.md @ 4897:42a362a2bf51

mod_portcheck: Shell command to check if ports are open
author Kim Alvefur <zash@zash.se>
date Fri, 18 Feb 2022 18:35:45 +0100
parents
children
comparison
equal deleted inserted replaced
4896:54fa2116bbf3 4897:42a362a2bf51
1 This module adds a `portcheck` command to the [shell][doc:console]
2 intended for use with health checks, i.e. to check whether Prosody is
3 listening to all expected ports.
4
5 # Usage
6
7 After installing and enabling the module a command like this becomes
8 available:
9
10 ``` bash
11 prosodyctl shell "portcheck [::]:5222 *:5222 [::]:5269 *:5269"
12 ```
13
14 This would check if the c2s (`5222`) and s2s (`5269`) ports are
15 available on both IPv6 (`*`) and *Legacy IP*^[often referred to as IPv4].
16
17 # Compatibility
18
19 Compatible with Prosody **trunk**, will **not** work with 0.11.x or
20 earlier.