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
Document Helm chart deployment, mark Compose snippets as examples
- New "Kubernetes (Helm)" section on getting-started, with tabs for
standalone and alongside-Aidbox modes, pointing at the published
HealthSamurai/helm-charts/mdmbox chart.
- Intro line clarifies the Compose blocks are minimal examples for
local trial runs, not production manifests.
- Add commented MDMBOX_LICENSE hint to both compose examples so users
know where to put the JWT.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: docs/getting-started.md
+57-6Lines changed: 57 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,8 @@ MDMbox is distributed as a Docker image: `healthsamurai/mdmbox`.
8
8
9
9
It requires a PostgreSQL 14+ database. All configuration is done through environment variables.
10
10
11
+
The `docker-compose.yml` snippets below are minimal **examples for local trial runs** — clone, tweak, `docker compose up`. For Kubernetes, see [Kubernetes (Helm)](#kubernetes-helm).
12
+
11
13
## Standalone deployment
12
14
13
15
In standalone mode, MDMbox manages its own database. You need two containers: PostgreSQL and MDMbox.
@@ -40,6 +42,61 @@ docker-compose.yml
40
42
The `BOX_*` environment variables must match your Aidbox configuration exactly. MDMbox and Aidbox share the same PostgreSQL instance, FHIR data, and engine settings.
41
43
{% endhint %}
42
44
45
+
## Kubernetes (Helm)
46
+
47
+
For Kubernetes, MDMbox is published as a Helm chart: [HealthSamurai/helm-charts/mdmbox](https://github.com/HealthSamurai/helm-charts/tree/main/mdmbox). The chart does not provision PostgreSQL — bring your own (managed service, in-cluster operator, or [bitnami/postgresql](https://artifacthub.io/packages/helm/bitnami/postgresql)) — and supports the same two modes as the Compose examples above.
The full list of values is in the [chart README](https://github.com/HealthSamurai/helm-charts/blob/main/mdmbox/README.md).
88
+
89
+
## License
90
+
91
+
MDMbox requires a license to start. There are two ways to activate it:
92
+
93
+
1. **Environment variable.** Sign in to the [Aidbox portal](https://aidbox.app/ui/portal), open the MDMbox project, copy the license JWT, and pass it to the MDMbox container as `MDMBOX_LICENSE`. Recommended for production and CI.
94
+
2. **Browser activation.** Leave `MDMBOX_LICENSE` unset and start MDMbox. Open `http://localhost:3000`, click **Continue with Aidbox account**, sign in to the portal — a development MDMbox license is generated and stored in the database automatically. Useful for local development.
95
+
96
+
| Variable | Description | Required |
97
+
| --- | --- | --- |
98
+
| `MDMBOX_LICENSE` | License JWT copied from the Aidbox portal | No — falls back to browser activation |
99
+
43
100
## Configuration reference
44
101
45
102
### Database
@@ -54,12 +111,6 @@ MDMbox uses the standard Aidbox database environment variables:
54
111
| `BOX_DB_USER` | Database user | Yes |
55
112
| `BOX_DB_PASSWORD` | Database password | Yes |
56
113
57
-
### FHIR engine
58
-
59
-
MDMbox includes an embedded FHIR engine that uses the standard Aidbox `BOX_*` environment variables. In shared mode, these must match your Aidbox configuration. See the docker-compose examples above for the full list.
0 commit comments