prosody-modules
d194d1012fd3
mod_portcheck/README.md
Software / code / prosody-modules
File
mod_portcheck/README.md @ 5931:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
| author | Ben Smith <bens@effortlessis.com> |
|---|---|
| date | Mon, 13 May 2024 13:25:13 -0700 |
| 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.
