docs: install guide reflects runtime-fetched assets + Gitea token

install --from-stock and restore-stock fetch their per-board assets from the
private blueflare/alkane-stock-assets repo on first use, so document the
required Gitea token (ALKANE_RELEASE_TOKEN/GITEA_TOKEN, passed via a 0600 curl
config), the ALKANE_STOCK_ASSETS_BASE override, --allow-unsigned for bench
images, and --password-file for restore.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BdKQBPjAXpCwmigUov5eQk
This commit is contained in:
2026-11-11 11:21:33 -06:00
co-authored by Claude Opus 4.8
parent 684be52d5a
commit 27e1dc15e8
+24 -8
View File
@@ -38,22 +38,33 @@ on the command line, never stored by the toolkit.
Writing our first image onto a board that is still on genuine stock (past the
stock gates and getting root) is done by the toolkit itself, over the network.
The method is compiled into this binary; nothing else needs to be installed on
your machine. Add `--from-stock`:
The method is part of this binary; nothing else needs to be installed on your
machine. On first use it fetches a small set of per-board assets from our Gitea
(repo `blueflare/alkane-stock-assets`, release `zynq-7010-v1`) and caches them
locally, verifying each against a known SHA-256. That repo is private, so set a
Gitea token in the environment first (`ALKANE_RELEASE_TOKEN`, else
`GITEA_TOKEN`); it is passed to curl through a private 0600 config, never on the
command line. The asset base URL can be overridden with
`ALKANE_STOCK_ASSETS_BASE`.
Add `--from-stock`:
```
export ALKANE_RELEASE_TOKEN=<your-gitea-token>
alkane-cli afw install --latest --board zynq-7010 --host <miner-ip> \
--from-stock --confirm FLASH
```
The toolkit acquires and verifies the `.afw`, gates on compatibility, performs
the network-only stock-side install, then you verify the board came up as
alkane:
The toolkit acquires and verifies the `.afw`, gates on compatibility, fetches
and verifies its assets, performs the network-only stock-side install, then you
verify the board came up as alkane:
```
alkane-cli afw verify-live --host <miner-ip> --timeout 300
```
For a bench image that is not signed, add `--allow-unsigned`.
Without `--from-stock`, `install` performs a tier-2 update of a board already on
alkane: it writes the dtb (`/dev/mtd0 @ 0x1a00000`), the kernel
(`/dev/mtd0 @ 0x2000000`) and the rootfs (`/dev/mtd1`), holds a backup of each,
@@ -63,9 +74,14 @@ reads them back (md5), and never writes `/dev/mtd0` below `0x1a00000`
## Remove (back to stock)
```
alkane-cli afw restore-stock --host <miner-ip> --confirm FLASH
export ALKANE_RELEASE_TOKEN=<your-gitea-token>
alkane-cli afw restore-stock --host <miner-ip> \
--password-file <alkane-root-pw> --confirm FLASH
```
Returning an aftermarket board to genuine stock is also done by the toolkit
itself, over the network. You then verify independently that the board no longer
answers as alkane and presents its stock OS.
itself, over the network. It uses the same per-board assets (fetched/cached as
above, so the Gitea token is needed) and the board's alkane root credential
(`--password-file`, or `ALKANE_BOARD_PASSWORD`/`ALKANE_BOARD_PASSWORD_FILE`). You
then verify independently that the board no longer answers as alkane and
presents its stock OS.