snxraven/bare-operating-system
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update Docs

Browse Source
This commit is contained in:
Raven Scott
2026-04-22 21:11:28 -04:00
parent ff9a1f8888
commit 463e482198
19 changed files with 83 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference/environment-and-posix-appendix.md
+3 -2
View File
@@ -242,8 +242,9 @@ The list below is one **bullet per variable** in the form **name — component
- `BARE_OS_WWW_INITD` — Booter — When **`0`** / **`false`**, skips registering the **`bare-os-www`** initd unit (stock default: unit **on**).
- `BARE_OS_WWW_PORT` — Booter — TCP port for the loopback static HTTP server (default **`8088`**; must match the auto-managed Holesail entry when **`BARE_OS_WWW_HOLESAIL`** is on).
- `BARE_OS_WWW_HOST` — Booter — Bind address for **`bare-os-www`** (default **`127.0.0.1`**; **`0.0.0.0`** exposes the port on all interfaces — use only with care).
- `BARE_OS_HOLESAIL_STATE` — Booter — JSON path for **managed** Holesail tunnels (stock default **`/.bare/holesail/state.json`** on the personal drive — same file for **guest** and **unlocked** sessions; legacy **`~/.holesail/state.json`** is merged on first read when the stable file is empty).
- `BARE_OS_WWW_HOLESAIL` — Booter — When **`0`** / **`false`**, skips idempotently merging **`bare-www-<port>`** into managed Holesail **`state.json`** (stock **`BARE_OS_HOLESAIL_STATE`**, default **`/.bare/holesail/state.json`**) after the HTTP server listens (stock default: **on** so managed **`bare-holesail`** can expose the site).
- `BARE_OS_HOLESAIL_STATE` — Booter — Logical JSON path for **managed** Holesail tunnels. **Stock default:** **`~/.holesail/state.json`** (resolved under the session **`$HOME`**). **Override** this variable to use a different path (e.g. **`/.bare/holesail/state.json`** on the personal drive). On first read, if the primary file is missing or empty, legacy **`/.bare/holesail/state.json`**, **`/.bare/holesail/guest/state.json`**, and **`/home/guest/.holesail/state.json`** are merged. See handbook [ch.4 — The booter runtime](../../handbook/04-the-booter-runtime.md) (**§ bare-holesail**) for **`seed`** / **`key`** persistence.
- `BARE_OS_WWW_HOLESAIL` — Booter — When **`0`** / **`false`**, skips idempotently merging **`bare-www-<port>`** into managed Holesail **`state.json`** after **`bare-os-www`** listens (stock default: **on**).
- `BARE_OS_SSH_HOLESAIL` — Booter — When **`0`** / **`false`**, skips idempotently merging **`bare-ssh-<port>`** into the **same** managed **`state.json`** after **`bare-openssh`** listens (stock default: **on**). **`port`** / **`host`** match the actual SSH bind (defaults **`127.0.0.1:2222`** unless **`sshd_config`** / **`BARE_OS_SSH_*`** change them).
- `BARE_OS_COLLAB_SESSION_NDJSON` — Booter — When **`1`** / **`true`**, host boot trace may append collaboration session lines (non-secret peer counts) via swarm-disk logging.
- `BARE_OS_PHYS_PAGES_HINT` — Booter — Optional integer string for **`getconf _SC_PHYS_PAGES`** via **`ctx.bareOsGetconfSysconf`** (default **`524288`** when unset).
- `BARE_OS_SHELL_HEREDOC_MAX_BYTES` — Booter — When **`BARE_OS_SHELL_POSIX_MODE`** is on, caps here-document body size (default **`262144`**, max **2 MiB**).
docs/reference/package-bare-os-booter.md
+1 -1
View File
@@ -64,7 +64,7 @@ See also [Kernel subsystem map](../architecture/kernel-subsystems.md) and [ADR 0
- **`applyLogout({ save? })`** — optional **`save`** runs encrypted vault snapshot first (see `identity-session.js`).
- **`saveVault()`** — encrypt personal-drive files into `/.bare/vault/` (skips `/.bare`, `bin`, `boot`, history paths).
- **`registerKernelShutdownHook(fn)`** — register async/sync teardown before **`stopBareInitd`** when the REPL session cleans up.
- After **`createKernelReplSession`**: wires **`readLine`**, **`console`**, **`execLine`**, **`suspendReplForSubprocess`** / **`resumeReplAfterSubprocess`**, then **`await startBareInitd(ctx)`** (stock units include **`kernel-logger`**, **`bare-os-www`** — loopback static HTTP for **`~/.www`** — **`bare-holesail`**, **`bare-cron`**, **`bare-openssh`**, **`bare-os-chat`** when enabled, …).
- After **`createKernelReplSession`**: wires **`readLine`**, **`console`**, **`execLine`**, **`suspendReplForSubprocess`** / **`resumeReplAfterSubprocess`**, then **`await startBareInitd(ctx)`** (stock units include **`kernel-logger`**, **`bare-os-www`** — loopback static HTTP for **`~/.www`** — **`bare-holesail`** (managed **`~/.holesail/state.json`**: **`seed`**, **`key`**, stock **`bare-www-*`** / **`bare-ssh-*`** rows), **`bare-cron`**, **`bare-openssh`**, **`bare-os-chat`** when enabled, …).
- Sets **`disk.os`** **after initd** with **`createBareOsDiskOsBridge`** (**`searchLocal`** with optional path manifest, whitelisted **`execRpc`** / **`bare_os.*`**, **`disk_os_hints`** schema **3**, **`replication_operator_sketch`** schema **7**, cap-gated **`replication_operator_intent`** when **`BARE_OS_DISK_OS_OPERATOR_INTENT_RPC=1`**) — peers use **`SwarmDisk`** messages **3–6**; see [`bare-os-disk-os-bridge.js`](../../packages/bare-os-booter/lib/bare-os-disk-os-bridge.js) and §12.4.
- **`ctx.bareOsHrpcRequest`** (stock) — validates **`service`**, **`method`**, object **`payload`**; optional **`BARE_OS_HRPC_ALLOWLIST_JSON`**; built-in routes **`kernel.ping`**, **`kernel.capabilities`**, **`vfs.readText`**, **`bare_os.echo`**, **`bare_os.disk_os_hints`**, **`bare_os.search_local`**, **`bare_os.replication_operator_sketch`**, **`bare_os.replication_snapshot`**, **`bare_os.pkg_index_get`** (**`BARE_OS_HRPC_ROUTE_TABLE_SCHEMA_VERSION` 3**). **`BARE_OS_HRPC_EMIT_UNLISTED`** forwards unknown routes to **`process.emit('bare-os:hrpc-request', …)`** on Node when enabled.
- `try { await runKernelFromSource(...) } finally { await session.cleanup() }` — cleanup runs **`bareInitdShutdownActiveUnitsReverse`**, **`runKernelShutdownHooks`**, **`stopBareInitd`**, fish TTY teardown.