Skip to content

Commit 8324f2c

Browse files
docs(readme): rewrite Quick Start and Enterprise sections for clarity
Split Quick Start into three numbered steps (server, CLI, IDE connect) with accurate descriptions of what each installer actually does. Remove the commented-out Homebrew line and the misleading pipx-first ordering. Clarify in the Enterprise section that the same package ships for all editions and enterprise features activate at runtime via the license key. Co-authored-by: Hari Srinivasan <harisrini21@gmail.com>
1 parent 5868102 commit 8324f2c

2 files changed

Lines changed: 33 additions & 17 deletions

File tree

README.md

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -57,53 +57,59 @@ One command to install any agent into any supported IDE. The config files are ge
5757

5858
## Quick Start
5959

60-
### One-line server install
60+
Observal has two parts: a **server** (API + web UI + databases) you self-host, and a **CLI** you install on each developer machine.
61+
62+
### 1. Deploy the server
63+
64+
**One-line install** (requires Docker Engine ≥ 24.0 with Compose v2):
6165

6266
```bash
6367
curl -fsSL https://raw.githubusercontent.com/BlazeUp-AI/Observal/main/install-server.sh | bash
6468
```
6569

66-
Downloads a config package, runs guided setup, pulls Docker images from GHCR, and starts the full stack.
70+
This downloads a Docker Compose package, runs guided setup (domain, secrets, ports), pulls container images from GHCR, and starts the full stack (API, web UI, PostgreSQL, ClickHouse, Redis, worker, load balancer, Prometheus, Grafana).
6771

68-
### From source
72+
**From source** (for contributors):
6973

7074
```bash
7175
git clone https://github.com/BlazeUp-AI/Observal.git && cd Observal
7276
cp .env.example .env
7377
make up
7478
```
7579

76-
### Install the CLI
80+
### 2. Install the CLI
81+
82+
**Standalone binary** (no Python required):
7783

7884
```bash
79-
# pip / pipx (all platforms)
80-
pipx install observal-cli
85+
curl -fsSL https://raw.githubusercontent.com/BlazeUp-AI/Observal/main/install.sh | bash
86+
```
8187

82-
# Or with uv
83-
# uv tool install observal-cli
88+
**Python** (3.11+):
8489

85-
# Homebrew (macOS, Linux)
86-
# brew install BlazeUp-AI/observal/observal-cli
90+
```bash
91+
uv tool install observal-cli
92+
# or: pipx install observal-cli
8793
```
8894

89-
### Connect your IDE
95+
### 3. Connect your IDE
9096

9197
```bash
9298
observal auth login
9399
observal doctor --patch
94100
```
95101

96-
This registers your IDE, installs telemetry hooks, and starts capturing sessions automatically.
102+
This authenticates with your server, detects your IDE, installs telemetry hooks, and starts capturing sessions automatically.
97103

98-
Once logged in, run `/observal` inside your IDE and it'll take the wheel. Pull agents, submit components, browse the registry, run diagnostics, manage your setup:
104+
Once logged in, run `/observal` inside your IDE and it takes the wheel. Pull agents, submit components, browse the registry, run diagnostics:
99105

100106
```
101107
/observal pull security-auditor
102108
/observal scan
103109
/observal doctor
104110
```
105111

106-
Or just tell your agent what you want and it'll figure out the right commands via the CLI.
112+
Or just tell your agent what you want and it figures out the right commands.
107113

108114
---
109115

@@ -199,9 +205,15 @@ Enterprise adds:
199205

200206
![Audit log with PHI sensitivity badges and chain hashes](docs/img/audit_logging.png)
201207

208+
The server and CLI are the same package for all editions. Enterprise features activate at runtime when a valid license key is present:
209+
202210
```bash
203-
# Enterprise install
211+
# Pass the key during server install
204212
curl -fsSL https://raw.githubusercontent.com/BlazeUp-AI/Observal/main/install-server.sh | bash -s -- --license-key YOUR_KEY
213+
214+
# Or add it later to your .env
215+
echo 'OBSERVAL_LICENSE_KEY=your.key' >> .env
216+
make rebuild
205217
```
206218

207219
---

ee/observal_server/routes/audit.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,9 @@ async def export_audit_logs(
196196
]
197197
),
198198
media_type="application/json",
199-
headers={"Content-Disposition": f"attachment; filename=observal_audit-log_{datetime.utcnow().strftime('%Y%m%dT%H%M%SZ')}.json"},
199+
headers={
200+
"Content-Disposition": f"attachment; filename=observal_audit-log_{datetime.utcnow().strftime('%Y%m%dT%H%M%SZ')}.json"
201+
},
200202
)
201203

202204
# CSV export with standard column headers
@@ -233,5 +235,7 @@ async def export_audit_logs(
233235
return StreamingResponse(
234236
iter([output.getvalue()]),
235237
media_type="text/csv",
236-
headers={"Content-Disposition": f"attachment; filename=observal_audit-log_{datetime.utcnow().strftime('%Y%m%dT%H%M%SZ')}.csv"},
238+
headers={
239+
"Content-Disposition": f"attachment; filename=observal_audit-log_{datetime.utcnow().strftime('%Y%m%dT%H%M%SZ')}.csv"
240+
},
237241
)

0 commit comments

Comments
 (0)