From 05c79daccb30d8651d0f16024b0c145db91f1597 Mon Sep 17 00:00:00 2001 From: Sulthan Nauval Abdillah Date: Tue, 4 Aug 2026 07:12:04 +0000 Subject: [PATCH] docs: explain what an airgapped update does to your config and data MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - `copilot-update` refuses to run on an airgapped host, so the README is the only place the update path is written down - record the pre-upgrade steps: full `~/.rantaiclaw` tarball, stop the console, and carry the previous bundle in — it is the only way back - explain the config snapshot the installer now takes, and why: the schema migrates one way, after which an older rantaiclaw refuses the profile outright - note that `rantaiclaw rollback` is useless here — it reads snapshots only `rantaiclaw update` creates, and that needs network - note that the session/memory databases do NOT refuse a newer schema, so they fail at query time rather than up front; that asymmetry is what the tarball covers. Both are unchanged 0.8.3-alpha → 0.16.4-alpha, verified - warn that skill directories are replaced wholesale on every install - `tests/` was missing from "What's in here", and install.sh deploys to the profile now, not the workspace --- README.md | 35 ++++++++++++++++++++++++++++++----- 1 file changed, 30 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6232d54..32aeddb 100644 --- a/README.md +++ b/README.md @@ -113,9 +113,33 @@ copilot-web # web console → http://localhost:3939 (runs off > The full `rantaiclaw setup` also walks channels / MCP, and those sections need network — on a > fully offline host stick to `rantaiclaw setup provider`. -**Update** (there is no online update): download a newer `rantai-copilot-airgapped-` -bundle on a connected machine, transfer it, and re-run `./setup-airgapped.sh`. To build the bundle -yourself on a connected **same-arch** host: `release/pack-airgapped.sh `. +**Update** — there is no online update; `copilot-update` on an airgapped host just prints these +steps. Download a newer `rantai-copilot-airgapped-` bundle on a connected machine, +transfer it, and re-run `./setup-airgapped.sh`. To build the bundle yourself on a connected +**same-arch** host: `release/pack-airgapped.sh `. + +Before upgrading, on the target host — and carry the **previous** bundle in as well, it is your +only way back: +```bash +tar czf ~/rantaiclaw-backup-$(date +%F).tar.gz -C ~ .rantaiclaw +copilot-web stop +``` + +**Rolling back.** The installer copies `config.toml` to `config.toml.pre-` before the new +binary can touch it, because the config schema migrates one way: after the new binary's first real +command, an older rantaiclaw refuses the profile outright (`schema_version=N is newer than this +binary supports`). To go back, restore that copy and re-run the **old** bundle's +`./setup-airgapped.sh`. `rantaiclaw rollback` will not help you here — it reads snapshots that only +`rantaiclaw update` creates, and that needs network. + +> The full backup above covers what the config snapshot cannot. Neither `sessions/sessions.db` nor +> `workspace/memory/brain.db` refuses a schema newer than it understands, so an older binary opens +> one without complaint and would only fail later, at query time, and only if a migration had been +> destructive. Both schemas are in fact unchanged from 0.8.3-alpha through 0.16.4-alpha — the +> tarball is what covers you the day that stops holding. + +> `setup-airgapped.sh` replaces each skill directory wholesale. If anyone edited files under +> `~/.rantaiclaw/profiles//skills/`, copy them out first. ### From source (other platforms, or your own RantaiClaw) @@ -124,7 +148,7 @@ For CPUs/OSes the prebuilt bundle doesn't cover, or to use a RantaiClaw you buil ```bash git clone https://github.com/RantAI-dev/RantAI-Copilot cd RantAI-Copilot -./install.sh # deploy the skills into your RantaiClaw workspace +./install.sh # deploy the skills into your RantaiClaw profile rantaiclaw setup # set your LLM provider + key (if you haven't) ./web-ui.sh # web console → http://localhost:3939 (later installed as: copilot-web) ``` @@ -189,11 +213,12 @@ COPILOT_UI_HOST=0.0.0.0 copilot-web # 2. bind all interfaces → http://