summaryrefslogtreecommitdiff
path: root/docs/MAINS_PROXY.md
blob: 7573cbe18bf5dcf17b91e411dc5e9179b2a74496 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# mains_proxy · HyBBX 2.8.0

Opt-in mesh linking Main or Secondary instances for `/proxymail` and `/proxychat`.

## Feature matrix

| Feature | Supported |
|---------|-----------|
| `/proxymail` cross-site | yes |
| `/proxychat` cross-site | yes |
| User account sync | no |
| Sysop actions over proxy | no |
| Raw Main-to-Main TCP bypass | no — HBX/Circuit only |

## Build matrix

| Item | Value |
|------|-------|
| CMake | `-DHYBBX_PLUGIN_MAINS_PROXY=ON` |
| INI | `[networks] mains_proxy=yes` |
| Template | `share/hybbx-mesh.ini.example` |
| Auth | Same as Secondary — `link_id`, `link_password` |

## Topology matrix

| Peer A | Peer B | Transport |
|--------|--------|-----------|
| Main | Main | HBX circuit client |
| Main | Secondary | HBX circuit client |
| Secondary | Secondary | via Main hub (typical) |

## Related

| Goal | Doc |
|------|-----|
| Topology | [TOPOLOGY.md](TOPOLOGY.md) |
| Manual | [MANUAL.md](MANUAL.md) |
git clone -b <branch> https://cgit.mode42.com/<repo>.git
git clone -b <branch> git://cgit.mode42.com/<repo>.git

info@mode42.com