Mercurial > prosody-modules
view mod_portcheck/README.md @ 5755:4a353ccce220
luacheckrc: Replace deprecated module:once with :on_ready
So that :once is warned about properly.
module:once was only added in trunk so it shouldn't have gotten very far
yet.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sat, 02 Dec 2023 11:10:43 +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.