@lacneu/atrium 0.1.1 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -98,6 +98,30 @@ two-environment-scope gotcha and the stateful/stateless lifecycle.
98
98
 
99
99
  For local development (no Docker), see [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md).
100
100
 
101
+ ## Frontend distribution (npm / CDN)
102
+
103
+ Besides the Docker image, the frontend is published to npm as a **prebuilt static
104
+ bundle** ([`@lacneu/atrium`](https://www.npmjs.com/package/@lacneu/atrium)) so you
105
+ can deploy the UI to any static host or CDN without building it yourself. It is
106
+ **origin-agnostic**: the Convex URL is read at runtime from a `/config.json` served
107
+ next to the bundle, so one artifact serves any deployment.
108
+
109
+ > The bundle is only the UI — you still run the Convex backend and the bridge (see
110
+ > [Quickstart](#quickstart)). Serve a `config.json` next to `index.html`:
111
+ >
112
+ > ```json
113
+ > { "convexUrl": "https://convex.example.com" }
114
+ > ```
115
+
116
+ - **npm** — `npm install @lacneu/atrium`, then copy the package's `dist/` to your
117
+ static host / bucket / CDN and drop your `config.json` beside `index.html`.
118
+ - **Pin a version straight from a CDN** (e.g. in a deploy script) — no install:
119
+ - `https://unpkg.com/@lacneu/atrium@<version>/dist/`
120
+ - `https://cdn.jsdelivr.net/npm/@lacneu/atrium@<version>/dist/`
121
+ - **Docker** — the published frontend image serves the same `dist/` and writes
122
+ `/config.json` from the `CONVEX_URL` env at startup (this is what the Quickstart
123
+ uses).
124
+
101
125
  ## Documentation
102
126
 
103
127
  - [Architecture](docs/ARCHITECTURE.md) — components, data flow, auth.
@@ -105,6 +129,8 @@ For local development (no Docker), see [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md
105
129
  - [Configuration](docs/CONFIGURATION.md) — environment variable reference.
106
130
  - [Bridge protocol](docs/BRIDGE_PROTOCOL.md) — bridge ↔ Convex ↔ gateway contract.
107
131
  - [Deployment](docs/DEPLOYMENT.md) → points to [`deploy/`](deploy/).
132
+ - [Deployment troubleshooting](deploy/TROUBLESHOOTING.md) — first-deploy problems
133
+ with diagnosis + fix (private images, sign-in/JWT, agent discovery, …).
108
134
  - [OpenClaw version compatibility](docs/OPENCLAW_VERSION_COMPAT.md).
109
135
  - [Compliance / Trust Center](compliance/) — SOC 2 control mapping (incl. the
110
136
  metadata-only `/api/v1` surface) + the software-vs-operator