annotate mod_s2soutinjection/README.markdown @ 4312:33a41503b9e3

Improve UX by providing defaults users expect
author Seve Ferrer <seve@delape.net>
date Tue, 22 Dec 2020 11:27:20 +0100
parents e3e76e9693a1
children f4a9e804c457
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
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 s2s_connect_overrides = {
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 -- This one will use the default port, 5269
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 ["example.com"] = "xmpp.server.local";
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23 -- To set a different port:
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24 ["another.example"] = { "non-standard-port.example", 9999 };
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 }
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 # Compatibility
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29
e3e76e9693a1 mod_s2soutinjection: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30 Requires 0.9.x or later.