annotate mod_s2soutinjection/README.markdown @ 5668:ecfd7aece33b

mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 18:34:39 +0200
parents f4a9e804c457
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1999
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 ---
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 summary: S2S connection override
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 ...
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 # Introduction
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 This module is similar to [mod\_srvinjection] but less of an hack.
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 # Configuration
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 ``` lua
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 -- In the global section
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 modules_enabled = {
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 --- your other modules
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 "s2soutinjection";
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 }
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18
4932
f4a9e804c457 mod_s2soutinjection: Rewrite based on mod_onions for 0.12 compat (thanks Zash)
moparisthebest <admin@moparisthebest.com>
parents: 1999
diff changeset
19 -- targets must be IPs, not hostnames
1999
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 s2s_connect_overrides = {
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 -- This one will use the default port, 5269
4932
f4a9e804c457 mod_s2soutinjection: Rewrite based on mod_onions for 0.12 compat (thanks Zash)
moparisthebest <admin@moparisthebest.com>
parents: 1999
diff changeset
22 ["example.com"] = "1.2.3.4";
1999
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24 -- To set a different port:
4932
f4a9e804c457 mod_s2soutinjection: Rewrite based on mod_onions for 0.12 compat (thanks Zash)
moparisthebest <admin@moparisthebest.com>
parents: 1999
diff changeset
25 ["another.example"] = { "127.0.0.1", 9999 };
1999
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 }
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27 ```
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29 # Compatibility
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30
4932
f4a9e804c457 mod_s2soutinjection: Rewrite based on mod_onions for 0.12 compat (thanks Zash)
moparisthebest <admin@moparisthebest.com>
parents: 1999
diff changeset
31 Requires 0.9.x or later. Tested on 0.12.0