gsadmin/temetro
1
0
Fork 0
mirror of https://github.com/temetro/temetro.git synced 2026-08-26 02:17:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

infra/docs: Docker Hub release pipeline, versioning, README overhaul

Browse Source 
Reference prebuilt temetro/temetro-{backend,frontend} images in docker-compose
(with a build fallback) and stop baking the frontend API URL. Add a
tag-triggered GitHub Actions release workflow that pushes both images and cuts
a GitHub Release, plus RELEASING.md, CHANGELOG.md, and a root version. Overhaul
the root and frontend READMEs (screenshot, features, prebuilt-image quickstart,
LAN access, updating).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Khalid Abdi
2026-06-26 21:34:44 +03:00
parent 403e0e38e9
commit 130f90bf6a
9 changed files with 334 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files
backend/README.md
+10 -1
View File
@@ -9,9 +9,16 @@ shape exactly.
## Quick start (Docker)
```bash
docker compose up # db + backend + frontend — no setup needed
docker compose pull # fetch prebuilt images from Docker Hub (fast)
docker compose up -d # db + backend + frontend — no setup needed
```
`docker compose up --build` instead builds from source (for development). The
Compose file references the published `temetro/temetro-backend` and
`temetro/temetro-frontend` images with a build fallback, so the same file serves
both clinics and developers. Update with `docker compose pull && docker compose
up -d` (see [`../RELEASING.md`](../RELEASING.md)).
No `.env` or manual secret generation is required: on first start the backend
generates any missing secrets (`BETTER_AUTH_SECRET`, `AI_CREDENTIALS_KEY`) and
persists them to a Docker volume, so they stay stable across restarts. Create a
@@ -72,6 +79,8 @@ Other org-scoped resources follow the same pattern (CRUD, role-gated):
| Analytics | `GET /api/analytics` | — (any member) | computed clinic aggregates |
| Conversations | `/api/conversations` | — (participant-scoped) | staff messaging; real-time over Socket.io |
| Notifications | `/api/notifications` | — (per-recipient) | auto-generated; `read-all` + per-id read |
| Version | `GET /api/version` | — (public) | running version + GitHub-release update check |
| Network | `GET /api/network` | — (public) | detected LAN addresses for sharing the app |
Real-time messaging and live notifications are delivered over **Socket.io**, attached to the same
HTTP server; the handshake is authenticated with the Better Auth session cookie.