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:

FileComponent
DockerfileThe service
Dockerfile.gatewayThe v2 gateway, a thin BFF in front of the coordinator
Dockerfile.coordinatorThe coordinator and decision routing
Dockerfile.trainingThe training components
docker compose up -d          # full stack
docker compose -f docker-compose.coordinator.yml up -d   # coordinator only

Environment

VariablePurpose
AWARE_CREDENTIAL_PEPPERPepper for credential hashing. Required (or SECRET_KEY).
AWARE_GATEWAY_KILL_SWITCHSet to 1 to make the gateway return 503 immediately.
AWARE_GATEWAY_MAX_BODY_BYTESRequest body limit enforced before the proxy fires.