Installation
From npm
npm install @goodciso/aware@2.12.3
The package is Apache-2.0 and ships the service, the policy engine, the compliance mapper and the disclosure tooling. The React operator UI is built separately.
With Docker
Four images ship in the repository:
| File | Component |
|---|---|
Dockerfile | The service |
Dockerfile.gateway | The v2 gateway, a thin BFF in front of the coordinator |
Dockerfile.coordinator | The coordinator and decision routing |
Dockerfile.training | The training components |
docker compose up -d # full stack
docker compose -f docker-compose.coordinator.yml up -d # coordinator only
Environment
| Variable | Purpose |
|---|---|
AWARE_CREDENTIAL_PEPPER | Pepper for credential hashing. Required (or SECRET_KEY). |
AWARE_GATEWAY_KILL_SWITCH | Set to 1 to make the gateway return 503 immediately. |
AWARE_GATEWAY_MAX_BODY_BYTES | Request body limit enforced before the proxy fires. |