Skip to content

docs: scope "the runtime image" to ObjectOS where the claim depends on it #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-bill merged 2 commits into from
Sep 2, 2026
Merged

docs: scope "the runtime image" to ObjectOS where the claim depends on it #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01883c7
docs: scope "the runtime image" to ObjectOS where the claim depends o…
os-bill Sep 2, 2026
38cdd9a
docs: scope two more referent-dependent uses of "the runtime image"
os-bill Sep 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/docs/build/marketplace.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ You ─→ ObjectOS ─→ Marketplace tab ─→ pick app ─→ Install

| Catalog | Source | When to use |
|---|---|---|
| **Default** | Pre-bundled with the runtime image | First-time eval, demos, offline |
| **Default** | Pre-bundled with the ObjectOS runtime image | First-time eval, demos, offline |
| **ObjectStack public catalog** | Public app registry | Latest community + first-party apps |
| **Private catalog** | Your own published artifacts | Internal apps you don't want public |
| **Local** | Files mounted into the runtime | Air-gapped, custom builds |
Expand Down
5 changes: 3 additions & 2 deletions content/docs/deploy/air-gapped.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,9 @@ with it.

## Getting the image inside the network

The runtime image lives in a private registry that a disconnected site cannot
reach, so the image crosses the boundary the way your other artefacts do.
The ObjectOS runtime image lives in a private registry that a disconnected
site cannot reach, so the image crosses the boundary the way your other
artefacts do.

Do the verification on the connected side, while you still have the registry
and the tooling: check the **signature**, the **SBOM** and the **build
Expand Down
2 changes: 1 addition & 1 deletion content/docs/reference/environment-variables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ they can be used.
| Retired name | What to use instead |
|---|---|
| `OS_ARTIFACT_FILE` | `OS_ARTIFACT_URL`. Nothing in the shipped runtime reads `OS_ARTIFACT_FILE`; a deployment that sets it gets the boot it would have got with nothing set, and no error naming the mistake. A local file is `file://` on the replacement, and the replacement carries the integrity pin. |
| `OS_ARTIFACT_PATH` | `OS_ARTIFACT_URL`. **The runtime image refuses a boot that carries a non-default `OS_ARTIFACT_PATH`**, naming the replacement. Two spellings for "which artifact do I boot" is one dialect too many, and the retired one never carried an integrity pin. |
| `OS_ARTIFACT_PATH` | `OS_ARTIFACT_URL`. **The ObjectOS runtime image refuses a boot that carries a non-default `OS_ARTIFACT_PATH`**, naming the replacement. Two spellings for "which artifact do I boot" is one dialect too many, and the retired one never carried an integrity pin. |
| `OS_BUSINESS_DB_URL` | `OS_DATABASE_URL`, or a datasource declared in the artifact. Nothing reads `OS_BUSINESS_DB_URL`; a deployment that sets it and nothing else has no database configured at all. |

`OS_CLOUD_API_KEY` is **not** a variable a self-hosted deployment sets. It is
Expand Down
4 changes: 2 additions & 2 deletions content/docs/reference/runtime-capabilities.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ when an optional package is missing during development — but in
1. Treat capability warnings as deployment failures. Grep startup logs
for `capability not loaded` (or your equivalent) and fail the
readiness probe / rollout if any appear.
2. Pin the runtime image to one that includes every package your
artifacts declare in `requires`.
2. Pin the ObjectOS runtime image to one that includes every package
your artifacts declare in `requires`.
3. When publishing an artifact, document its `requires` list alongside
it so operators can verify the matching image.

Expand Down