summaryrefslogtreecommitdiff
path: root/local/README.md
diff options
context:
space:
mode:
authorinfo@mode42.com <info@mode42.com>2026-08-07 18:23:28 +0000
committerinfo@mode42.com <info@mode42.com>2026-08-07 18:23:28 +0000
commitfa05a5f8238e9e1417235711656e5062ccc843a7 (patch)
tree46fbbd18de54492b59307c16efcc7f3152723238 /local/README.md
Initial push
Diffstat (limited to 'local/README.md')
-rw-r--r--local/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/local/README.md b/local/README.md
new file mode 100644
index 0000000..633e98f
--- /dev/null
+++ b/local/README.md
@@ -0,0 +1,25 @@
+# Site-local configuration (not committed)
+
+Your own copies live here. This directory is **gitignored** except this file.
+
+**Never commit** live INI files, passwords, hostnames, or other site-private data. The setup wizard (`max25-lite-setup.sh`) can write here for you when you choose "No" at the save-location screen.
+
+**Localhost only:** MAX25-Stack-Lite runs max25d, the modem, and the terminal on the **same PC** — see the vault [localhost-policy.md](https://github.com/ngteq/MAX25-Stack-Lite) (or the copy shipped with your build). Do not set `tcp_host` to a LAN address.
+
+## Typical files
+
+| File | Written by | Used by |
+|------|------------|---------|
+| `max25d.ini` | wizard or manual copy of `share/max25/max25d.lite*.ini.example` | `run-max25d.sh ./local/max25d.ini` |
+| `crdop.ini` | wizard (CRDOP path) | `crdop -c ./local/crdop.ini` |
+| `max25-bcpr.ini` | wizard (BayCom/based path) | `max25-bcpr-ctl start --ini ./local/max25-bcpr.ini` |
+
+## Quick start (no sudo)
+
+```bash
+./scripts/max25-lite-setup.sh # choose "No" (system config) at the save-location screen
+./scripts/run-max25d.sh ./local/max25d.ini
+./scripts/run-max25-terminal.sh -U /run/max25/modem.sock
+```
+
+`tcp_password` stays empty on Lite — loopback only, no LAN auth to manage.
git clone -b <branch> https://cgit.mode42.com/<repo>.git
git clone -b <branch> git://cgit.mode42.com/<repo>.git

info@mode42.com