Skip to main content

Documentation Index

Fetch the complete documentation index at: https://parmanasystems.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

@parmanasystems/server is the production-ready Fastify server that exposes the Parmana Systems governance runtime as a REST API. It wraps @parmanasystems/execution-runtime and @parmanasystems/verifier behind authenticated HTTP endpoints.

Install

npm install @parmanasystems/server

Running

# Development (hot reload)
npm run dev --workspace=packages/server

# Production
npm run build --workspace=packages/server
node packages/server/dist/index.js
Or via the monorepo root:
npm run dev

Endpoints

MethodPathDescription
POST/executeExecute a governed decision, returns ExecutionAttestation
POST/verifyVerify a signed ExecutionAttestation
See API Reference for full request/response documentation.

Configuration

Environment variables:
VariableDescriptionDefault
PORTServer listen port3000
PARMANA_API_KEYEnable Bearer token authunset (auth disabled)
REDIS_URLRedis connection string for distributed replay storeunset (uses in-memory)
DATABASE_URLPostgreSQL for audit-db persistenceunset (audit disabled)
AWS_KMS_KEY_IDKMS key ARN for production signingunset (uses local key)

Production hardening

The server ships with production-ready Fastify plugins:
  • @fastify/cors — CORS headers
  • @fastify/helmet — security headers (CSP, HSTS, etc.)
  • @fastify/rate-limit — rate limiting to prevent abuse
  • @fastify/swagger — auto-generated OpenAPI schema at /documentation

OpenAPI UI

In development, the Swagger UI is available at:
http://localhost:3000/documentation
The schema is also exported to openapi.json at the project root via:
npm run export:openapi