Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/deploy-hardening.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
## New runtime flags
- `--command-rate-limit <int>` (default: `30`)
- `--command-rate-window <seconds>` (default: `60`)
- `--kore-host <host>` + `--kore-port <port>` (optional TCP mode to reach OpenKore endpoint)

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

If your OpenKore endpoint is TCP (instead of Unix socket), replace `--socket ...` with:

```bash
--kore-host 127.0.0.1 --kore-port 2350
```

## Operational notes
- Keep bind host as `127.0.0.1` and publish via VPN tunnel.
- Avoid exposing gateway directly to public internet at this stage.
Expand Down
9 changes: 9 additions & 0 deletions docs/gateway-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,15 @@
perl tools/remote_gateway.pl --socket /path/to/console.socket --listen-host 127.0.0.1 --listen-port 18085
```

### Alternative OpenKore endpoint mode (TCP)
If OpenKore bus is exposed via TCP, the gateway can connect with:

```bash
perl tools/remote_gateway.pl --kore-host 127.0.0.1 --kore-port 2350 --listen-host 127.0.0.1 --listen-port 18085
```

Use either `--socket` (Unix socket mode) or `--kore-host` + `--kore-port` (TCP mode).

## Health check
```bash
curl -s http://127.0.0.1:18085/health
Expand Down
Loading
Loading