Skip to content

Commit 0a294e8

Browse files
committed
gateway: add optional TCP OpenKore endpoint mode for cross-platform use
1 parent ec44103 commit 0a294e8

5 files changed

Lines changed: 701 additions & 5 deletions

File tree

docs/deploy-hardening.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
## New runtime flags
1010
- `--command-rate-limit <int>` (default: `30`)
1111
- `--command-rate-window <seconds>` (default: `60`)
12+
- `--kore-host <host>` + `--kore-port <port>` (optional TCP mode to reach OpenKore endpoint)
1213

1314
## Recommended launch (VPN-first)
1415
```bash
@@ -29,6 +30,12 @@ perl tools/remote_gateway.pl \
2930
# cp tools/gateway-users.example.json /etc/openkore/gateway-users.json
3031
```
3132

33+
If your OpenKore endpoint is TCP (instead of Unix socket), replace `--socket ...` with:
34+
35+
```bash
36+
--kore-host 127.0.0.1 --kore-port 2350
37+
```
38+
3239
## Operational notes
3340
- Keep bind host as `127.0.0.1` and publish via VPN tunnel.
3441
- Avoid exposing gateway directly to public internet at this stage.

docs/gateway-core.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,15 @@
2020
perl tools/remote_gateway.pl --socket /path/to/console.socket --listen-host 127.0.0.1 --listen-port 18085
2121
```
2222

23+
### Alternative OpenKore endpoint mode (TCP)
24+
If OpenKore bus is exposed via TCP, the gateway can connect with:
25+
26+
```bash
27+
perl tools/remote_gateway.pl --kore-host 127.0.0.1 --kore-port 2350 --listen-host 127.0.0.1 --listen-port 18085
28+
```
29+
30+
Use either `--socket` (Unix socket mode) or `--kore-host` + `--kore-port` (TCP mode).
31+
2332
## Health check
2433
```bash
2534
curl -s http://127.0.0.1:18085/health

0 commit comments

Comments
 (0)