gortium/openconcho
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: document dev/prod compose modes and make targets

Browse Source 
README, docs/docker.md, and AGENTS.md now cover make compose-up (dev-forward,
builds from source) vs make compose-up-prod (pulls ghcr latest) and compose-down.
This commit is contained in:
Offending Commit
2026-06-02 13:51:23 -05:00
parent c9bd2db07d
commit e1285c73ad
3 changed files with 52 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -89,23 +89,29 @@ pnpm --filter @openconcho/desktop dev
### Docker (web app)
Run the web UI in a container — handy for adding it to a self-hosted Honcho
Compose stack. The image serves the SPA and reverse-proxies the Honcho API under
its own origin: the browser calls `/api` same-origin and names the upstream in an
The container serves the SPA and reverse-proxies the Honcho API under its own
origin: the browser calls `/api` same-origin and names the upstream in an
`X-Honcho-Upstream` header, so there's no browser CORS to configure.
Two Compose modes (the published image is `ghcr.io/offendingcommit/openconcho-web`):
```bash
docker run --rm -p 8080:8080 \
-e OPENCONCHO_DEFAULT_HONCHO_URL=http://host.docker.internal:8000 \
ghcr.io/offendingcommit/openconcho-web:latest
# Dev-forward — build from this repo and run your local changes:
OPENCONCHO_DEFAULT_HONCHO_URL=https://honcho.example.net make compose-up
# Production — pull the latest published image instead of building:
OPENCONCHO_DEFAULT_HONCHO_URL=https://honcho.example.net make compose-up-prod
make compose-down # stop + remove
# → http://localhost:8080
```
`OPENCONCHO_DEFAULT_HONCHO_URL` seeds the first instance (absolute URL).
`OPENCONCHO_UPSTREAM_ALLOWLIST` is an optional SSRF guard (comma-separated host
globs) for when you expose the proxy. To drop it into a Honcho Compose stack, use
the `openconcho` service in [`docker-compose.yml`](docker-compose.yml). Full
details and env vars are in [`docs/docker.md`](docs/docker.md).
`make compose-up` uses [`docker-compose.yml`](docker-compose.yml) (`build: .`);
`make compose-up-prod` layers [`docker-compose.prod.yml`](docker-compose.prod.yml)
to pull `ghcr…:latest`. `OPENCONCHO_DEFAULT_HONCHO_URL` seeds the first instance
(absolute URL); `OPENCONCHO_UPSTREAM_ALLOWLIST` is an optional SSRF guard
(comma-separated host globs) for when you expose the proxy. Full details and env
vars are in [`docs/docker.md`](docs/docker.md).
### Connecting to your instance