docs: commit all Phase 6 documentation updates and OpenSpec archives
- devops docs: 8 files updated for Phase 6 state; field-trial.md added (946-line runbook) - developer docs: api-reference (50+ endpoints), quick-start, 5 existing guides updated, 5 new guides added - engineering docs: all 12 files updated (services, architecture, SDK guide, testing, overview) - OpenSpec archives: phase-7-devops-field-trial, developer-docs-phase6-update, engineering-docs-phase6-update - VALIDATOR.md + scripts/start-validator.sh: V&V Architect tooling added - .gitignore: exclude session artifacts, build artifacts, and agent workspaces Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -6,9 +6,12 @@ Complete setup guide for running AgentIdP locally.
|
||||
|
||||
| Tool | Minimum version | Purpose |
|
||||
|------|----------------|---------|
|
||||
| Docker + Docker Compose | 24+ | Run PostgreSQL and Redis |
|
||||
| Node.js | 18.0.0 | Run the application and migrations |
|
||||
| Docker | 24+ | Container runtime |
|
||||
| Docker Compose | 2.20+ | Multi-container orchestration |
|
||||
| Node.js | 18.0.0 | Run the application, portal, and migrations |
|
||||
| npm | 9+ | Package management and scripts |
|
||||
| nvm | any | Recommended for managing Node.js versions |
|
||||
| openssl | any | RSA key generation |
|
||||
|
||||
Verify versions:
|
||||
|
||||
@@ -19,6 +22,11 @@ node --version
|
||||
npm --version
|
||||
```
|
||||
|
||||
> **nvm activation:** If using nvm, activate it before running any Node.js commands:
|
||||
> ```bash
|
||||
> export NVM_DIR="$HOME/.nvm" && source "$NVM_DIR/nvm.sh"
|
||||
> ```
|
||||
|
||||
---
|
||||
|
||||
## Step 1 — Clone and install dependencies
|
||||
@@ -27,6 +35,9 @@ npm --version
|
||||
git clone https://git.sentryagent.ai/vijay_admin/sentryagent-idp.git
|
||||
cd sentryagent-idp
|
||||
npm install
|
||||
|
||||
# Install portal dependencies
|
||||
cd portal && npm install && cd ..
|
||||
```
|
||||
|
||||
---
|
||||
@@ -127,11 +138,10 @@ Expected output:
|
||||
```
|
||||
Running database migrations...
|
||||
✓ Applied: 001_create_agents.sql
|
||||
✓ Applied: 002_create_credentials.sql
|
||||
✓ Applied: 003_create_audit_events.sql
|
||||
✓ Applied: 004_create_tokens.sql
|
||||
...
|
||||
✓ Applied: 026_add_tenant_tiers.sql
|
||||
|
||||
Migrations complete. 4 migration(s) applied.
|
||||
Migrations complete. 26 migration(s) applied.
|
||||
```
|
||||
|
||||
See [database.md](database.md) for full migration documentation.
|
||||
@@ -165,9 +175,52 @@ The compiled output is written to `dist/`. `npm start` runs `node dist/server.js
|
||||
|
||||
---
|
||||
|
||||
## Step 7 — Start the Next.js portal (optional)
|
||||
|
||||
The portal is a Next.js 14 application in the `portal/` directory. It communicates with the
|
||||
AgentIdP backend at `http://localhost:3000`.
|
||||
|
||||
Start the portal development server:
|
||||
|
||||
```bash
|
||||
cd portal && npm run dev
|
||||
```
|
||||
|
||||
The portal starts on port 3001 by default. Open http://localhost:3001.
|
||||
|
||||
Available routes:
|
||||
|
||||
| Route | Description |
|
||||
|-------|-------------|
|
||||
| `/login` | OAuth 2.0 login page |
|
||||
| `/agents` | Agent registry |
|
||||
| `/credentials` | Credential management |
|
||||
| `/audit` | Audit log viewer |
|
||||
| `/analytics` | Token trend and agent activity charts |
|
||||
| `/settings/tier` | Tier status and upgrade |
|
||||
| `/compliance` | AGNTCY compliance report |
|
||||
| `/webhooks` | Webhook subscription management |
|
||||
| `/marketplace` | Agent marketplace |
|
||||
|
||||
Build the portal for production:
|
||||
|
||||
```bash
|
||||
cd portal && npm run build
|
||||
cd portal && npm start # serves the production build
|
||||
```
|
||||
|
||||
Ensure `CORS_ORIGIN` in your `.env` includes `http://localhost:3001`:
|
||||
```
|
||||
CORS_ORIGIN=http://localhost:3001
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Full Docker Compose Stack
|
||||
|
||||
> **Note:** The `app` service in `docker-compose.yml` requires a `Dockerfile` which has not been written yet. This is a **Phase 1 P1 pending item**. The commands below will work once the Dockerfile exists.
|
||||
> The full Docker Compose stack (including the `app` container) is available for field trial
|
||||
> deployments — see the [field trial guide](field-trial.md). For day-to-day development, start
|
||||
> only the infrastructure services and run the application directly.
|
||||
|
||||
When the Dockerfile is available, the entire stack (infrastructure + application) can be started with:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user