Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/api/environment-routing.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -125,5 +125,5 @@ one, so they are intentionally excluded from data-plane resolution.
## Related

- [Single-Environment Mode](/docs/deployment/single-project-mode)
- [Deployment Modes](/docs/deployment)
- [Deployment Overview](/docs/deployment)
- [Client SDK](/docs/api/client-sdk)
2 changes: 1 addition & 1 deletion content/docs/deployment/environment-variables.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,7 +63,7 @@ read at startup unless noted otherwise. Boolean variables accept `true` / `false

| Variable | Type | Default | Description |
|:---|:---|:---|:---|
| `OS_SECRET_KEY` | string | — | 32-byte master key (64 hex chars or base64) for `sys_secret` encryption — encrypted settings, `secret` fields, datasource credentials. **Required** for containerized or multi-node deployments; on a single durable host `os start` mints and persists a dev key instead. See [Deployment Modes](/docs/deployment#environment-variables). |
| `OS_SECRET_KEY` | string | — | 32-byte master key (64 hex chars or base64) for `sys_secret` encryption — encrypted settings, `secret` fields, datasource credentials. **Required** for containerized or multi-node deployments; on a single durable host `os start` mints and persists a dev key instead. See [Self-Hosted Deployment](/docs/deployment/self-hosting#the-minimum-viable-production-environment). |
| `OS_DEV_CRYPTO_KEY` | string | — | Development convenience crypto key, consulted after `OS_SECRET_KEY`. Do not use in production. |
| `OS_CLUSTER_DRIVER` | string | `memory` | Cluster coordination driver id. When set to anything other than `memory`, the runtime treats the deployment as multi-node (and requires `OS_SECRET_KEY`). Non-memory drivers are opt-in sibling packages (e.g. `redis` via `@objectstack/service-cluster-redis`) — see [Cluster](/docs/kernel/cluster). |
| `OS_REDIS_URL` | url | — | Connection URL passed to a non-memory cluster driver (e.g. `OS_CLUSTER_DRIVER=redis`). |
Expand Down
306 changes: 164 additions & 142 deletions content/docs/deployment/index.mdx

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions content/docs/deployment/meta.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,15 +2,15 @@
"title": "Deployment & Operations",
"pages": [
"index",
"cli",
"validating-metadata",
"self-hosting",
"backup-restore",
"production-readiness",
"backup-restore",
"tenancy-modes",
"single-project-mode",
"publish-and-preview",
"validating-metadata",
"cli",
"environment-variables",
"single-project-mode",
"tenancy-modes",
"troubleshooting"
]
}
2 changes: 1 addition & 1 deletion content/docs/deployment/publish-and-preview.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -218,6 +218,6 @@ boot-time schema-drift policy, against a local file.
- [Artifact-pinned boot](/docs/deployment/self-hosting#artifact-pinned-boot-os_artifact_url) — the operational detail for `OS_ARTIFACT_URL`: schemes, integrity pinning, cache behaviour, pre-signed URLs
- [CLI reference](/docs/deployment/cli)
- [Packages](/docs/plugins/packages)
- [Deployment Modes](/docs/deployment)
- [Deployment Overview](/docs/deployment)
- [Environment Variables](/docs/deployment/environment-variables)
- [Environment-Scoped Routing](/docs/api/environment-routing)
4 changes: 2 additions & 2 deletions content/docs/deployment/self-hosting.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ platform publishes an official runtime image on every release, and Compose and
Kubernetes are shapes of that same path rather than alternatives to it. Bare
Node.js under systemd is the minority path, kept for hosts where a container
runtime is not available or not permitted. It assumes you have read
[Deployment Modes](/docs/deployment).
[Deployment Overview](/docs/deployment).

The deployment model is deliberately simple:

Expand DownExpand Up@@ -430,7 +430,7 @@ Disable with `OS_MCP_SERVER_ENABLED=false`. See
## Related

- [Backup & Restore](/docs/deployment/backup-restore) — what to back up, and the restore drill
- [Deployment Modes](/docs/deployment) — the map of local / standalone / Cloud
- [Deployment Overview](/docs/deployment) — the two lifecycles this section is organised around, and which pages belong to each
- [`os start` reference](/docs/deployment/cli#os-start) — every flag and env var
- [Environment Variables](/docs/deployment/environment-variables) — the full catalog
- [Troubleshooting & FAQ](/docs/deployment/troubleshooting)
9 changes: 6 additions & 3 deletions content/docs/deployment/single-project-mode.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,8 +17,11 @@ This is the mode used by:
- `createStandaloneStack()` / `createDefaultHostConfig()` in
`@objectstack/runtime`

Use [Deployment Modes](/docs/deployment) when you need to publish to an
ObjectOS Cloud control plane or test environment-scoped routing.
Need more than one environment? [Publish, Versioning &
Preview](/docs/deployment/publish-and-preview) covers publishing to an ObjectOS
Cloud control plane, and [Environment-Scoped
Routing](/docs/api/environment-routing) covers resolving an environment per
request.

---

Expand DownExpand Up@@ -107,5 +110,5 @@ environments, provision databases, or mount a control plane.
## Related

- [Environment-Scoped Routing](/docs/api/environment-routing)
- [Deployment Modes](/docs/deployment)
- [Deployment Overview](/docs/deployment)
- [CLI reference](/docs/deployment/cli)
Loading