diff options
| author | info@mode42.com <info@mode42.com> | 2026-08-07 18:25:13 +0000 |
|---|---|---|
| committer | info@mode42.com <info@mode42.com> | 2026-08-07 18:25:13 +0000 |
| commit | 04d965d67a7264a1c7c211494aebda1953df7603 (patch) | |
| tree | 0ebd700a6e219f84a26a656f4bee8778bc75da7b /local/README.md | |
Initial push
Diffstat (limited to 'local/README.md')
| -rw-r--r-- | local/README.md | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/local/README.md b/local/README.md new file mode 100644 index 0000000..514c133 --- /dev/null +++ b/local/README.md @@ -0,0 +1,52 @@ +# Site-local configuration (not committed) + +Operator copies live here. This directory is **gitignored** except this README. + +**Never commit** live INI, env, keys, passwords, hostnames, UART inventories, or other site-private data. Public examples stay under `share/**/*.example`. + +## Typical files (examples) + +| File | Install target | +|------|----------------| +| `max25d.ini` | `/etc/max25/max25d.ini` | +| Serial env (per device) | `/etc/max25/` | +| `bcpr.ini` (BayCom/based / bcpr) | `/etc/max25/max25-bcpr.ini` (or symlink here) | + +Fill secrets from `local/passwords.env` (generate with the vault `local-generate-secrets.sh` tool). Do not leave placeholders in live files. + +## Deploy (sketch) + +```bash +sudo cp local/max25d.ini /etc/max25/max25d.ini +sudo mkdir -p /run/max25 +sudo max25d -c /etc/max25/max25d.ini +``` + +## Terminal (canonical) + +```bash +max25-terminal -U /run/max25/modem.sock +# DEVICE from max25d [devices] default — optional override: +# -d <id> | SET DEVICE <id> | F10 → 7 +``` + +Prefer `/usr/local/bin/max25-terminal` or `build*/bin/max25-terminal`. Path is **`stacks/terminal/`**, never `stacks/daemon/`. + +Unix socket: max25d binds then `chmod 0660`. If the daemon runs as **root**, a non-root client gets connect refused/EACCES — use `sudo max25-terminal …`, or run max25d as the same user/group that owns the terminal. + +Site wiring, host roles, and purchase/serial inventory live only in the private research vault — not in this repository. + +## bcpr prove-out (workstation) + +```bash +# Preferred: max25d auto_start +max25d -c local/max25d.ini +max25-terminal -U /run/max25/modem.sock +# CONNECT → SEND … + +# Manual bcpr only when debugging: +sudo ./stacks/max25-bcpr/tools/max25-bcpr-ctl -c /etc/max25/max25-bcpr.ini preflight +sudo ./stacks/max25-bcpr/tools/max25-bcpr-ctl -c /etc/max25/max25-bcpr.ini start +``` + +`tcp_password` comes from `passwords.env` → `MAX25_TCP_PASSWORD`. |