From 4b8fccb5e81c6c43b25518e845822821d01c38bb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=B2=20Boschi?= Date: Thu, 4 Dec 2025 10:09:55 +0100 Subject: [PATCH] fix readme github images --- .github/workflows/release.yml | 41 ++++++++++++++++--- README.md | 2 +- hindsight-docs/docs/developer/installation.md | 28 +++++++++---- uv.lock | 6 +-- 4 files changed, 59 insertions(+), 18 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a8e2cd8f..fffac9ac 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -254,10 +254,41 @@ jobs: id: get_version run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT - - name: Download all artifacts + - name: Download Python packages uses: actions/download-artifact@v4 with: - path: ./artifacts + name: python-packages + path: ./artifacts/python-packages + + - name: Download TypeScript client + uses: actions/download-artifact@v4 + with: + name: typescript-client + path: ./artifacts/typescript-client + + - name: Download Rust CLI (Linux) + uses: actions/download-artifact@v4 + with: + name: rust-cli-hindsight-linux-amd64 + path: ./artifacts/rust-cli-linux + + - name: Download Rust CLI (macOS Intel) + uses: actions/download-artifact@v4 + with: + name: rust-cli-hindsight-darwin-amd64 + path: ./artifacts/rust-cli-darwin-amd64 + + - name: Download Rust CLI (macOS ARM) + uses: actions/download-artifact@v4 + with: + name: rust-cli-hindsight-darwin-arm64 + path: ./artifacts/rust-cli-darwin-arm64 + + - name: Download Helm chart + uses: actions/download-artifact@v4 + with: + name: helm-chart + path: ./artifacts/helm-chart - name: Prepare release assets run: | @@ -269,9 +300,9 @@ jobs: # TypeScript client cp artifacts/typescript-client/*.tgz release-assets/ || true # Rust CLI binaries - cp artifacts/rust-cli-hindsight-linux-amd64/hindsight-linux-amd64 release-assets/ || true - cp artifacts/rust-cli-hindsight-darwin-amd64/hindsight-darwin-amd64 release-assets/ || true - cp artifacts/rust-cli-hindsight-darwin-arm64/hindsight-darwin-arm64 release-assets/ || true + cp artifacts/rust-cli-linux/hindsight-linux-amd64 release-assets/ || true + cp artifacts/rust-cli-darwin-amd64/hindsight-darwin-amd64 release-assets/ || true + cp artifacts/rust-cli-darwin-arm64/hindsight-darwin-arm64 release-assets/ || true # Helm chart cp artifacts/helm-chart/*.tgz release-assets/ || true ls -la release-assets/ diff --git a/README.md b/README.md index 14028f26..90e5f3f0 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ docker run -p 8888:8888 -p 9999:9999 \ -e HINDSIGHT_API_LLM_PROVIDER=openai \ -e HINDSIGHT_API_LLM_API_KEY=$OPENAI_API_KEY \ -e HINDSIGHT_API_LLM_MODEL=gpt-4o-mini \ - vectorize/hindsight + ghcr.io/vectorize-io/hindsight ``` - **API**: http://localhost:8888 diff --git a/hindsight-docs/docs/developer/installation.md b/hindsight-docs/docs/developer/installation.md index e7ac50c8..3332acb3 100644 --- a/hindsight-docs/docs/developer/installation.md +++ b/hindsight-docs/docs/developer/installation.md @@ -27,7 +27,24 @@ You need an LLM API key for fact extraction, entity resolution, and answer gener **Best for**: Quick start, development, small deployments -Docker Compose bundles all dependencies (PostgreSQL with pgvector, API server, Control Plane) in a single command. +### Single Container (Quickest) + +Run everything in one container with embedded PostgreSQL: + +```bash +docker run -p 8888:8888 -p 9999:9999 \ + -e HINDSIGHT_API_LLM_PROVIDER=openai \ + -e HINDSIGHT_API_LLM_API_KEY=sk-xxxxxxxxxxxx \ + -e HINDSIGHT_API_LLM_MODEL=gpt-4o-mini \ + ghcr.io/vectorize-io/hindsight +``` + +- **API Server**: http://localhost:8888 +- **Control Plane** (Web UI): http://localhost:9999 + +### Docker Compose + +For more control, use Docker Compose which bundles all dependencies separately: ```bash # Clone the repository @@ -36,20 +53,13 @@ cd hindsight # Create environment file cp .env.example .env -# Edit .env with your LLM API key: -# HINDSIGHT_API_LLM_PROVIDER=groq -# HINDSIGHT_API_LLM_API_KEY=gsk_xxxxxxxxxxxx +# Edit .env with your LLM API key # Start all services cd docker ./start.sh ``` -**Services started**: -- **API Server**: http://localhost:8888 -- **Control Plane** (Web UI): http://localhost:3000 -- **Swagger UI**: http://localhost:8888/docs - **Management**: ```bash ./stop.sh # Stop services diff --git a/uv.lock b/uv.lock index 9f91d4db..fe9f3491 100644 --- a/uv.lock +++ b/uv.lock @@ -1141,7 +1141,7 @@ provides-extras = ["test"] [[package]] name = "hindsight-api" -version = "0.0.14" +version = "0.0.15" source = { editable = "hindsight-api" } dependencies = [ { name = "alembic" }, @@ -1243,7 +1243,7 @@ dev = [ [[package]] name = "hindsight-client" -version = "0.0.14" +version = "0.0.15" source = { editable = "hindsight-clients/python" } dependencies = [ { name = "aiohttp" }, @@ -1275,7 +1275,7 @@ provides-extras = ["test"] [[package]] name = "hindsight-dev" -version = "0.0.14" +version = "0.0.15" source = { editable = "hindsight-dev" } dependencies = [ { name = "hindsight-api" },