summaryrefslogtreecommitdiff
path: root/docs/BUILD.md
blob: 52d65922c8dedf14aec9917d014ed046eca65729 (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
38
39
40
41
42
43
44
# Build · HyBBX 2.8.0

POSIX+ build reference. Platforms: [PLATFORMS.md](PLATFORMS.md).

## Build matrix

| Step | Command |
|------|---------|
| Release build | `cmake -B build -DCMAKE_BUILD_TYPE=Release && cmake --build build` |
| Run | `./scripts/hybbx.sh` |
| Test | `-DHYBBX_BUILD_TESTS=ON` → `ctest --test-dir build` |
| Telnet smoke | `telnet 127.0.0.1 2323` |
| SSH smoke | `ssh 127.0.0.1 -p 3232` |

## CMake options matrix

| Option | Default | Description |
|--------|---------|-------------|
| `HYBBX_BUILD_DAEMON` | ON | `hybbxd` + core |
| `HYBBX_BUILD_CLIENTS` | ON | CLI clients |
| `HYBBX_PLUGIN_PACKET_RADIO` | ON | Packet radio |
| `HYBBX_PLUGIN_BAYCOM` | ON | BayCom plugin (v2.8.0 built; runtime off) |
| `HYBBX_PLUGIN_MAINS_PROXY` | OFF | Main-to-Main mesh proxy |
| `HYBBX_PLUGIN_ARDOP` | ON | ARDOP plugin |
| `HYBBX_PLUGIN_CRDOP` | ON | CRDOP plugin |
| `HYBBX_PLUGIN_SSH` | ON | SSH (libssh) |
| `HYBBX_PLUGIN_WEBSOCKET` | ON | WebSocket proxy |
| `HYBBX_BUILD_TESTS` | OFF | Unit tests |
| `HYBBX_STORAGE_SQLITE` | ON | SQLite backend |

## Config matrix

| Item | Value |
|------|-------|
| Live INI | `./local/hybbx.ini` (gitignored) |
| Templates | `share/hybbx-*.ini.example` |
| Secrets | `./local/` only — never commit |

## Related

| Goal | Doc |
|------|-----|
| Platforms | [PLATFORMS.md](PLATFORMS.md) |
| Developer | [DEVELOPMENT.md](DEVELOPMENT.md) |
git clone -b <branch> https://cgit.mode42.com/<repo>.git
git clone -b <branch> git://cgit.mode42.com/<repo>.git

info@mode42.com