first commit

README.md

@@ -0,0 +1,65 @@
+This repository is a local-only demo to observe how the components work together. It is not meant as a production reference or a security baseline.
+
+## Prerequisites
+
+- Docker and Docker Compose
+- mkcert (for local TLS certificates)
+- A local hosts file entry for the demo domains (see below)
+
+## Quick start
+
+1. Copy the sample environment file and set your host IP:
+
+   ```bash
+   cp .env.sample .env
+   ```
+
+   Edit `.env` and set `HOST_IP` (do not use `127.0.0.1`, required by LiveKit and the reverse proxy).
+
+2. Add local domain mappings in your hosts file (do not use `127.0.0.1`):
+
+   ```
+   <HOST_IP> app.hublot.local
+   <HOST_IP> auth.hublot.local
+   <HOST_IP> auth-admin.hublot.local
+   <HOST_IP> livekit.hublot.local
+   ```
+
+3. Install mkcert and generate local certificates:
+
+   ```bash
+   mkcert -cert-file certs/localhost.pem -key-file certs/localhost-key.pem \
+     app.hublot.local auth.hublot.local auth-admin.hublot.local livekit.hublot.local
+   ```
+
+4. Start the stack:
+
+   ```bash
+   docker compose up -d
+   ```
+
+## Services and URLs
+
+- Hublot app: https://app.hublot.local
+- Logto (OIDC): https://auth.hublot.local
+- Logto admin: https://auth-admin.hublot.local
+- LiveKit: https://livekit.hublot.local
+
+## Default accounts (Logto)
+
+- Admin: `admin / hublotlogto`
+- Demo users:
+  - `demo1 / hublotdemo`
+  - `demo2 / hublotdemo`
+
+## Data reset
+
+To clear local data volumes and reset the stack state:
+
+```bash
+./reset.sh
+```
+
+## Notes
+
+- Use the host machine IP in `HOST_IP` and your hosts file; `127.0.0.1` will be misinterpreted inside containers.