@@ -21,10 +21,23 @@ links and its install form all point at `/`.
22- Kernel `[%zuse 408]`.
22- Kernel `[%zuse 408]`.
23- `%landscape`, which provides `%treaty` and `%docket`. Fresh ships have it.
23- `%landscape`, which provides `%treaty` and `%docket`. Fresh ships have it.
24−- Nix, for the one-command build. Without it, copy `desk/` from a checkout.
24+- Nix, for the one-command build, if you install from source. Without it,
25+ copy `desk/` from a checkout.
29+Install %shelf from ~donmec-sallud, which publishes it:
32+~sampel-palnet:dojo> |install ~donmec-sallud %shelf
35+%shelf then gets its updates from ~donmec-sallud.
36+[shelf.iko.soy](https://shelf.iko.soy) is %shelf running on that ship. It
37+lists all the apps ~donmec-sallud offers, %shelf among them.
39+To install from source instead, build the desk:
29nix build github:iko-soy/shelf
42nix build github:iko-soy/shelf
@@ -48,10 +61,10 @@ chmod -R u+w /path/to/pier/shelf # files from the Nix store are read-only
48~sampel-palnet:dojo> |install our %shelf
61~sampel-palnet:dojo> |install our %shelf
51−The page is now at `https://<your-ship>/shelf`, and Landscape shows a Shelf
64+Either way, once %shelf runs, the page is at `https://<your-ship>/shelf`, and
52−tile that opens it. It is meant to be opened through your own domain, though:
65+Landscape shows a Shelf tile that opens it. It is meant to be opened through
53−on the ship's address the page renders, but its links lead to `/`, which
66+your own domain, though: on the ship's address the page renders, but its links
54−belongs to Landscape.
67+lead to `/`, which belongs to Landscape.
56## Building with Nix
69## Building with Nix
@@ -93,11 +106,14 @@ result/
109+A %shelf installed from ~donmec-sallud gets its updates from that ship.
96−Build and copy the desk into the mount again, as above, and run
111+To update a source install, build and copy the desk into the mount again, as
97−`|commit %shelf`. Then check that `.^(cass:clay %cw /=shelf=)` moved: if the
112+above, and run `|commit %shelf`. Then check that `.^(cass:clay %cw /=shelf=)`
98−new version doesn't build, Clay keeps the old one and logs nothing.
113+moved: if the new version doesn't build, Clay keeps the old one and logs
100−%shelf is installed from your own ship, so it gets no over-the-air updates.
116+A source install comes from your own ship, so it gets no over-the-air updates.
101After a kernel upgrade, Clay holds it until `desk/sys.kelvin` lists the new
117After a kernel upgrade, Clay holds it until `desk/sys.kelvin` lists the new
102`%zuse` version; update that file (or pull a release that has) and commit.
118`%zuse` version; update that file (or pull a release that has) and commit.
103`+vats %shelf` shows whether it is running or held.
119`+vats %shelf` shows whether it is running or held.
@@ -273,6 +289,9 @@ after %shelf stops. Until you remove it, `/shelf` answers 503 at once.
273 Landscape. This removes the tile and suspends the agent; a plain
289 Landscape. This removes the tile and suspends the agent; a plain
274 `|uninstall %shelf` would leave a suspended tile behind. Your `head`/`body`
290 `|uninstall %shelf` would leave a suspended tile behind. Your `head`/`body`
275 HTML is kept, and `|install our %shelf` brings the page straight back.
291 HTML is kept, and `|install our %shelf` brings the page straight back.
292+ Uninstalling a %shelf installed from ~donmec-sallud also stops its updates.
293+ To turn them back on, run `|install ~donmec-sallud %shelf` after
294+ `|install our %shelf`.
2763. To delete that state too: `|nuke %shelf, =desk &` (answer `y`).
2953. To delete that state too: `|nuke %shelf, =desk &` (answer `y`).
2774. Optionally, free the path. Only the binding's owner can remove it, so take
2964. Optionally, free the path. Only the binding's owner can remove it, so take
278 it over from the dojo, then remove it:
297 it over from the dojo, then remove it: