Quickstarts

Quickstart: One-click apps

Install Metabase, Grafana, Umami and more, wired to your database.

Apps run in their own containers with a dedicated database role and schema.

Variables used below: $HOSTBASE_TOKEN (access token), $REF (project ref). SDKs: @hostbase/management (TypeScript) and hostbase_management (Python); full reference at /docs/api.

1. Browse the catalog

curl https://host.ulewicz.space/api/v1/apps -H "Authorization: Bearer $HOSTBASE_TOKEN"
const catalog = await hb.listAppCatalog();
catalog = hb.list_app_catalog()
hostbase apps catalog

2. Install

First-login credentials are returned only once.

curl -X POST https://host.ulewicz.space/api/v1/projects/$REF/apps -H "Authorization: Bearer $HOSTBASE_TOKEN" -H "Content-Type: application/json" -d '{"app":"metabase","admin_email":"me@example.com"}'
const installed = await hb.installApp({ ref, body: { app: "metabase", admin_email: "me@example.com" } as never });
hb.install_app(ref=ref, body={"app": "metabase", "admin_email": "me@example.com"})
hostbase apps install metabase --admin-email me@example.com

3. Manage

Start, stop, restart, upgrade, logs and removal.

curl -X POST https://host.ulewicz.space/api/v1/projects/$REF/apps/metabase/restart -H "Authorization: Bearer $HOSTBASE_TOKEN"
await hb.appAction({ ref, app: "metabase", action: "restart" });
hb.app_action(ref=ref, app="metabase", action="restart")
hostbase apps restart metabase

Next: /docs/aplikacje-1-klik.