Mercurial > prosody-modules

annotate mod_portcheck/README.md @ 5818:d3b69859553a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_password_policy: Change error type from 'cancel' to 'modify' This makes more sense, as the problem relates to the data that has been entered, and therefore the request could be retried with different data.
author Matthew Wild <mwild1@gmail.com>
date Mon, 08 Jan 2024 17:28:39 +0000
parents 42a362a2bf51
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4897
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 This module adds a `portcheck` command to the [shell][doc:console]
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 intended for use with health checks, i.e. to check whether Prosody is
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 listening to all expected ports.
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 # Usage
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 After installing and enabling the module a command like this becomes
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 available:
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 ``` bash
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 prosodyctl shell "portcheck [::]:5222 *:5222 [::]:5269 *:5269"
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 ```
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 This would check if the c2s (`5222`) and s2s (`5269`) ports are
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 available on both IPv6 (`*`) and *Legacy IP*^[often referred to as IPv4].
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 # Compatibility
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 Compatible with Prosody **trunk**, will **not** work with 0.11.x or
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 earlier.