Getting Started with VectorVue
This guide brings a new environment from zero to a working commercial demo.
Security baseline for this deployment:
- Client API telemetry ingestion is retired.
- SpectraStrike federation uses internal telemetry gateway only.
- mTLS + Ed25519 signed telemetry are mandatory.
Objective
By the end of this guide you will have:
- Full platform deployed
- Tenant demo data loaded
- Client portals accessible
- API and compliance endpoints validated
Prerequisites
- Docker and Docker Compose installed
makeavailable- Hosts entries for local tenant domains if required by your environment
Recommended local host mapping:
acme.vectorvue.local->127.0.0.1globex.vectorvue.local->127.0.0.1
Step 1: Deploy Services
Recommended guided flow:
make wizard
Select:
1for full commercial deploy4for demo seeding
Direct command path:
make deploy
This starts API, portal, runtime services, workers, PostgreSQL, Redis, and nginx.
Step 2: Seed Demo Data
make seed-clients
This creates multi-tenant demo content including campaigns, findings, reports, remediation tasks, analytics records, and compliance-ready activity data.
Step 3: Access Portals
Open:
https://acme.vectorvue.local/loginhttps://globex.vectorvue.local/login
Use credentials from Demo Access Matrix.
Step 4: Validate API Health
make api-smoke
Expected result:
- API health check returns healthy
- OpenAPI responds successfully
Step 5: Validate Compliance Endpoints
Call any tenant-authenticated endpoint, for example:
GET /compliance/frameworksGET /compliance/ISO27001/score
Compliance API responses are signed and tenant scoped.
Step 6: Validate Worker Health
docker compose ps
Confirm these services are up:
vectorvue_ml_workervectorvue_compliance_observation_workervectorvue_compliance_daily_worker
Optional: Real Tenant Onboarding (No Dummy Data)
Create a production-style tenant and users only:
make tenant-bootstrap-real \
TENANT_ID=30000000-0000-0000-0000-000000000003 \
TENANT_NAME="RealCorp Manufacturing" \
TENANT_ADMIN_USER=realcorp_admin \
TENANT_ADMIN_PASS='RealCorpAdm1n!' \
TENANT_CLIENT_USER=realcorp_viewer \
TENANT_CLIENT_PASS='RealCorpView3r!'
Validate Phase 7-9 endpoint behavior for that tenant:
make phase79-real-smoke \
TENANT_ID=30000000-0000-0000-0000-000000000003 \
TENANT_ADMIN_USER=realcorp_admin \
TENANT_ADMIN_PASS='RealCorpAdm1n!'
Guided alternative:
make wizard
Select:
3to bootstrap a real tenant5to run real scenario validation
Optional: Fully Isolated Client Portal Stack
make customer-deploy-portal-isolated \
CUSTOMER=realcorp \
TENANT_ID=30000000-0000-0000-0000-000000000003 \
TENANT_NAME="RealCorp Manufacturing" \
TENANT_PORTAL_HOST=realcorp.vectorvue.local
Guided alternative:
make wizard
Select option 2.
Optional: TUI Onboarding Wizard (Admin)
Use this when you want an in-app onboarding flow.
- Start TUI:
make run-tui
- Login with an admin account.
- Open onboarding wizard with
Ctrl+Shift+WorONBOARD WIZARDin sidebar. - Enter tenant and portal/company data:
- tenant id and name
- portal host
- company name + colors
- tenant admin and client credentials
- Click
CREATE TENANT + USERS.
Recommended First Walkthrough
- Client Portal: Overview -> Analytics -> Findings -> Remediation -> Reports -> Risk
- API: login -> findings -> risk -> telemetry event -> ML endpoint
- Compliance: frameworks -> controls -> score -> report
Troubleshooting
If migration or seed errors appear:
- Re-run
make deploy - Re-run
make seed-clients - Check logs:
docker compose logs --tail=100 vectorvue_app
docker compose logs --tail=100 vectorvue_postgres
For deeper troubleshooting use Troubleshooting Guide.