You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/docs/reference/environment-variables.mdx
+22-8Lines changed: 22 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,11 +19,16 @@ Use system settings for tenant/user-editable application configuration.
19
19
20
20
| Variable | Required | Description |
21
21
|---|---:|---|
22
-
|`OS_ARTIFACT_FILE`| File mode | Path to local compiled artifact used by this ObjectOS app wrapper. |
22
+
|`OS_ARTIFACT_FILE`| File mode | Path to a local compiled `objectstack.json`. Read by the ObjectOS app wrapper and forwarded as `fileConfig.artifactPath`. |
23
+
|`OS_ARTIFACT_PATH`| Alternative | Framework-level name for the same path or `http(s)://` URL. Honoured by `@objectstack/runtime` directly (CLI `dev`/`start`, standalone mode). |
23
24
|`OS_PROJECT_ID`| Optional | Project id for file-backed mode or explicit project identity. |
24
-
|`OS_WATCH_ARTIFACT`| No | Set to `1` to reload local artifact while developing. |
25
-
|`OS_CLOUD_URL`| Cloud mode | Control-plane base URL for hostname resolution and artifact fetch. |
25
+
|`OS_ENVIRONMENT_ID`| Optional | Environment id for standalone/file-backed mode (default `proj_local`). Also used to derive the per-project auth secret. |
26
+
|`OS_ORGANIZATION_ID`| Optional | Default organization id for file-backed mode (default `org_local`). |
27
+
|`OS_WATCH_ARTIFACT`| No | Set to `1` to reload the local artifact when it changes. Use only in development. |
28
+
|`OS_CLOUD_URL`| Cloud mode | Control-plane base URL for hostname resolution and artifact fetch. Set to `off` or `local` to opt out of cloud-connected behaviour. |
26
29
|`OS_CLOUD_API_KEY`| Optional | Bearer token for private control-plane Artifact API access. |
30
+
|`OS_MULTI_TENANT`| No | Set to `false` to disable multi-tenant routing (default `true`). |
31
+
|`OS_RUNTIME_PORT`| Dev only | Localhost port used to build platform-SSO callback URLs when developing on `http://localhost:<port>`. |
27
32
28
33
## Cache
29
34
@@ -46,11 +51,20 @@ Use system settings for tenant/user-editable application configuration.
46
51
47
52
## Database
48
53
49
-
Database configuration can come from the control-plane runtime response
50
-
or the artifact datasource declarations. Framework standalone mode also
51
-
recognizes `OS_DATABASE_URL`, `OS_DATABASE_DRIVER`, and
52
-
`OS_DATABASE_AUTH_TOKEN`.
54
+
In cloud-connected mode the control plane returns the per-project
55
+
runtime database configuration with the artifact response. In
56
+
file-backed mode ObjectOS reads datasource declarations from the
57
+
artifact. As a last resort the framework also honours:
58
+
59
+
| Variable | Description |
60
+
|---|---|
61
+
|`OS_DATABASE_URL`| Connection URL (`file:./db.sqlite`, `libsql://…`, `postgres://…`, `mongodb://…`, `memory://`). Used by standalone mode and CLI `dev`. |
62
+
|`OS_DATABASE_DRIVER`| Override the driver auto-detected from the URL. |
63
+
|`OS_DATABASE_AUTH_TOKEN`| Auth token for managed drivers such as Turso/libSQL. |
64
+
|`OS_BUSINESS_DB_URL`| ObjectOS wrapper convention for the per-project business database URL. Resolve it to `OS_DATABASE_URL` or a runtime datasource override in your deployment. |
65
+
|`OS_CACHE_DIR`| Local artifact and runtime cache directory (default `/var/cache/objectos`). |
66
+
|`OS_SKIP_SCHEMA_SYNC`| Set to `1` to skip ObjectQL DDL sync at boot. Use when schema is managed out-of-band. |
53
67
54
68
For ObjectOS customer deployments, prefer explicit control-plane runtime
55
-
configuration or artifact datasource configuration over undocumented
69
+
configuration or artifact datasource configuration over relying on
0 commit comments