Skip to content

Commit 206c4d5

Browse files
author
Ignacio Van Droogenbroeck
committed
docs: Docker/Compose/Helm install pointing at :latest; push Helm chart to GHCR OCI on release
1 parent 0be8a0a commit 206c4d5

2 files changed

Lines changed: 46 additions & 3 deletions

File tree

.github/workflows/release.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,14 @@ jobs:
120120
name: helm-chart
121121
path: dist/*.tgz
122122

123+
- name: Log in to GHCR (for OCI chart push)
124+
run: echo "${{ secrets.GITHUB_TOKEN }}" | helm registry login ghcr.io -u "${{ github.actor }}" --password-stdin
125+
126+
- name: Push chart to GHCR (OCI)
127+
run: |
128+
helm push dist/launchpad-${{ needs.prepare.outputs.version }}.tgz \
129+
oci://ghcr.io/${{ github.repository_owner }}/charts
130+
123131
release:
124132
name: GitHub Release
125133
runs-on: ubuntu-latest

README.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,16 +54,51 @@ The server listens on `$PORT` (default `3000`).
5454

5555
## Docker
5656

57+
Use the published image (`latest`, or pin a version tag from the [releases](https://github.com/basekick-labs/launchpad/releases)):
58+
5759
```bash
58-
docker build -t arc-launchpad .
5960
docker run -p 3000:3000 \
6061
-e LAUNCHPAD_JWT_SECRET=$(openssl rand -hex 32) \
61-
-v $(pwd)/data:/app/data \
62-
arc-launchpad
62+
-v launchpad-data:/app/data \
63+
ghcr.io/basekick-labs/launchpad:latest
6364
```
6465

6566
The SQLite database is written to `/app/data/launchpad.db` — mount a volume there to persist it.
6667

68+
## Docker Compose
69+
70+
```bash
71+
curl -O https://raw.githubusercontent.com/basekick-labs/launchpad/main/docker-compose.yml
72+
LAUNCHPAD_JWT_SECRET=$(openssl rand -hex 32) docker compose up -d
73+
```
74+
75+
The compose file uses `ghcr.io/basekick-labs/launchpad:latest` and a named volume for the data.
76+
77+
## Helm
78+
79+
```bash
80+
helm install launchpad oci://ghcr.io/basekick-labs/charts/launchpad \
81+
--set jwtSecret=$(openssl rand -hex 32) \
82+
--set baseUrl=https://launchpad.example.com
83+
```
84+
85+
Or from a release chart archive:
86+
87+
```bash
88+
# grab launchpad-<version>.tgz from the latest GitHub Release
89+
helm install launchpad ./launchpad-*.tgz --set jwtSecret=$(openssl rand -hex 32)
90+
```
91+
92+
Common values (see [`helm/launchpad/values.yaml`](helm/launchpad/values.yaml) for the full list):
93+
94+
| Value | Default | Purpose |
95+
|---|---|---|
96+
| `jwtSecret` | `""` | **Required** unless `existingSecret` is set. Signs session tokens. |
97+
| `existingSecret` | `""` | Name of a pre-created Secret holding `LAUNCHPAD_JWT_SECRET` instead. |
98+
| `baseUrl` | `http://localhost:3000` | Public URL (email links + passkey origin). |
99+
| `persistence.size` | `1Gi` | PVC size for the SQLite database. |
100+
| `ingress.enabled` | `false` | Enable to expose via an Ingress. |
101+
67102
## Connecting to an Arc instance
68103

69104
After signing in, add a connection with your Arc instance's endpoint URL (e.g. `http://localhost:8000`) and an admin token. Arc Launchpad verifies the connection and then lets you query and manage that instance.

0 commit comments

Comments
 (0)