Skip to content

Commit 01c8785

Browse files
authored
docs(deploy): add Kubero deployment guide and README entry (#101)
* docs(deploy): add Kubero deployment guide and README entry LibreDB Studio is now in the official Kubero template catalog (kubero-dev/kubero#754). Add deploy/kubero/README.md with install, env var, and version-bump notes, and a Kubero subsection under Deployment (DevOps) in the main README. * docs(deploy): link the live Kubero template catalog listing LibreDB Studio is now live on the Kubero templates page (https://www.kubero.dev/templates); point the README and Kubero deploy guide at the catalog listing instead of the bare site. * docs(deploy): address Copilot review on Kubero guide - Replace the pipe-to-shell Kubero install command with a link to the official Kubero install docs (avoid embedding curl | bash). - Wrap the README Kubero paragraph to match surrounding sections. * chore(package): bump version to 0.9.34
1 parent 15ca045 commit 01c8785

3 files changed

Lines changed: 90 additions & 2 deletions

File tree

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@ Deploy your own instance of LibreDB Studio with a single click on Koyeb, Render,
399399
400400
## Deployment (DevOps)
401401
402-
### Koyeb (Recommended for cloud deployment)
402+
### Koyeb
403403
404404
1. **Fork this repository**
405405
2. **Connect to Koyeb**: [app.koyeb.com](https://app.koyeb.com) → New → Blueprint
@@ -427,6 +427,18 @@ LibreDB Studio is published in the official [CapRover One-Click Apps](https://gi
427427
428428
The app runs the prebuilt `ghcr.io/libredb/libredb-studio` image. As with Railway, Docker-image templates require a manual version bump on each release.
429429
430+
### Kubero
431+
432+
LibreDB Studio is listed in the official
433+
[Kubero template catalog](https://www.kubero.dev/templates) (a self-hosted
434+
"Heroku alternative for Kubernetes"). From your Kubero dashboard, browse
435+
**Templates**, search **LibreDB Studio**, fill in the credentials / `JWT_SECRET`,
436+
and deploy. The template runs the prebuilt `ghcr.io/libredb/libredb-studio` image
437+
with SQLite persistence on a 5Gi volume at `/app/data`. See
438+
[`deploy/kubero/`](deploy/kubero/) for install and post-install details. As with
439+
Railway and CapRover, Docker-image templates require a manual version bump on
440+
each release.
441+
430442
### Render (Recommended for cloud deployment)
431443
432444
LibreDB Studio includes a `render.yaml` Blueprint for one-click deployment:

deploy/kubero/README.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# LibreDB Studio on Kubero
2+
3+
[Kubero](https://www.kubero.dev) is a self-hosted, open-source PaaS — a
4+
"Heroku alternative for Kubernetes" — that deploys 12-factor apps onto a cluster
5+
from a built-in template catalog.
6+
7+
LibreDB Studio is listed in the official
8+
[Kubero template catalog](https://www.kubero.dev/templates)
9+
(merged in [kubero-dev/kubero#754](https://github.com/kubero-dev/kubero/pull/754)).
10+
The canonical template lives in the Kubero repo at
11+
[`services/libredb-studio/app.yaml`](https://github.com/kubero-dev/kubero/blob/main/services/libredb-studio/app.yaml)
12+
as a `KuberoApp` custom resource; this folder is a documentation mirror, not the
13+
source of truth.
14+
15+
## Install
16+
17+
From a running Kubero instance (see the
18+
[Kubero install docs](https://docs.kubero.dev/docs/Getting-Started/Installation/)
19+
to set one up):
20+
21+
1. **Open your Kubero dashboard** → create or pick a pipeline/app, then browse
22+
**Templates**.
23+
2. **Search** for **LibreDB Studio**.
24+
3. **Fill in the variables** — admin/user credentials, a strong `JWT_SECRET`
25+
(32+ chars), and any optional AI/storage settings.
26+
4. **Deploy.**
27+
28+
## What the template does
29+
30+
- Runs the prebuilt `ghcr.io/libredb/libredb-studio` image (pinned tag, never
31+
`:latest`) with the `docker` deployment strategy on container HTTP port `3000`.
32+
- Persists saved connections & settings with **SQLite** (`STORAGE_PROVIDER=sqlite`)
33+
on a `5Gi` ReadWriteOnce volume mounted at `/app/data`, surviving restarts and
34+
redeploys — no external database required.
35+
- Ships configurable `ADMIN_EMAIL` / `ADMIN_PASSWORD`, `USER_EMAIL` /
36+
`USER_PASSWORD`, and `JWT_SECRET` env vars. The catalog defaults are
37+
placeholders — set real values before deploying.
38+
39+
## First login
40+
41+
After deploy, open the app's public URL and log in:
42+
43+
- **Admin** (full access incl. maintenance tools): `admin@libredb.org` + your
44+
`ADMIN_PASSWORD`.
45+
- **User** (query execution only): `user@libredb.org` + your `USER_PASSWORD`.
46+
47+
## Environment variables
48+
49+
See the [main README environment table](../../README.md#environment-variables)
50+
for the full list. Minimum required for a working Kubero deploy:
51+
52+
| Variable | Notes |
53+
|----------|-------|
54+
| `JWT_SECRET` | 32+ chars, set your own |
55+
| `ADMIN_EMAIL` / `ADMIN_PASSWORD` | admin login |
56+
| `USER_EMAIL` / `USER_PASSWORD` | standard user login |
57+
| `STORAGE_PROVIDER` | `sqlite` (default here); `postgres` for an external backend |
58+
59+
## Post-install options
60+
61+
Add these variables on the app to extend the deployment:
62+
63+
- **SSO / OIDC**`NEXT_PUBLIC_AUTH_PROVIDER=oidc`, `OIDC_ISSUER`,
64+
`OIDC_CLIENT_ID`, `OIDC_CLIENT_SECRET`, `OIDC_ROLE_CLAIM`, `OIDC_ADMIN_ROLES`.
65+
- **PostgreSQL storage backend** (multi-node) — `STORAGE_PROVIDER=postgres`,
66+
`STORAGE_POSTGRES_URL=...`.
67+
- **AI**`LLM_PROVIDER` (`gemini` | `openai` | `ollama` | `custom`),
68+
`LLM_API_KEY`, `LLM_MODEL`, `LLM_API_URL`.
69+
70+
## Version bumps
71+
72+
The catalog template pins a specific image tag. On each release, bump the tag in
73+
the Kubero repo's `services/libredb-studio/app.yaml` (same manual-bump caveat as
74+
the Railway and CapRover Docker-image templates).
75+
76+
More details and docs: https://github.com/libredb/libredb-studio

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@libredb/studio",
3-
"version": "0.9.33",
3+
"version": "0.9.34",
44
"private": false,
55
"publishConfig": {
66
"access": "public"

0 commit comments

Comments
 (0)