prosody-modules
12f7d8b901e0
mod_portcheck/README.md
Software / code / prosody-modules
File
mod_portcheck/README.md @ 5298:12f7d8b901e0
mod_audit: Support for adding location (GeoIP) to audit events
This can be more privacy-friendly than logging full IP addresses, and also
more informative to a user - IP addresses don't mean much to the average
person, however if they see activity from outside their expected country, they
can immediately identify suspicious activity.
As with IPs, this field is configurable for deployments that would like to
disable it. Location is also not logged when the geoip library is not
available.
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Sat, 01 Apr 2023 13:11:53 +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.
