docs: update README with OpenCode references and deployment guide

- Replace RunFusion with OpenCode in description
- Add frontend environment variables section
- Add deployment quick start guide
- Update scope boundaries with current task status
This commit is contained in:
2026-05-14 17:32:02 +02:00
parent 85ae390263
commit 1539a67883
+33 -3
View File
@@ -1,6 +1,6 @@
# Headquarter
Hosted workspace and tool-orchestration platform where authenticated users create projects, connect Git repositories, and spawn self-hosted tools such as RunFusion and code-server.
Hosted workspace and tool-orchestration platform where authenticated users create projects, connect Git repositories, and spawn self-hosted tools such as OpenCode and code-server.
## Current Status
@@ -8,7 +8,7 @@ This repository provides:
- React + Vite + TypeScript frontend (`apps/web`)
- FastAPI + Python backend (`apps/api`)
- Manifest-driven tool registry with built-in RunFusion and code-server definitions
- Manifest-driven tool registry with built-in OpenCode and code-server definitions
- Root monorepo tooling (pnpm workspace, Makefile)
- Docker Compose local development stack
- Deployment skeleton for Portainer + Traefik
@@ -90,6 +90,36 @@ See [Development](docs/development.md) for details on running these checks local
- [Deployment](docs/deployment.md) — Portainer/Traefik assumptions
- [Deploy Skeleton](deploy/README.md) — Deployment file reference
## Frontend Environment Variables
The frontend (`apps/web`) requires these environment variables:
| Variable | Description |
|----------|-------------|
| `VITE_API_URL` | Backend API base URL |
| `VITE_OIDC_ISSUER` | OIDC provider issuer URL |
| `VITE_OIDC_CLIENT_ID` | OIDC client ID |
| `VITE_OIDC_REDIRECT_URI` | Post-login redirect URL |
Copy `apps/web/.env.example` to `apps/web/.env` and fill in your values.
## Deployment
Deploy to production using Docker Compose:
```bash
# Copy and configure production environment
cp deploy/.env.example deploy/.env
# Edit deploy/.env with your domain and secrets
# Deploy locally for testing
docker compose -f docker-compose.prod.yml up --build -d
# Or deploy via Portainer using deploy/portainer-stack.yml
```
See [Deployment Guide](docs/deployment.md) for full details.
## Scope Boundaries
This scaffold intentionally defers detailed implementation to follow-up tasks:
@@ -99,7 +129,7 @@ This scaffold intentionally defers detailed implementation to follow-up tasks:
- **FN-006** — Full deployment automation, dynamic Traefik labels for spawned tool containers
- **FN-003** — Manifest-driven tool registry
- **FN-007** — Provider-independent Git connection model
- **FN-008** — RunFusion executable environment proof of concept
- **FN-008** — OpenCode terminal environment proof of concept
- **FN-009** — Persistent config and secrets handling
- **FN-010** — code-server manifest and spawn flow