Self-hosting

Run the Zeq OS api-server on your own hardware. The framework is open-core — clone, build, serve.

Repo hulyasmath/zeq-framework Stack Node 20+ · Postgres 16 · Docker (optional) Precision ≤0.1%

Quickstart — Docker Compose

git clone https://github.com/hulyasmath/zeq-framework
cd zeq-framework
cp .env.local.example .env.local
docker compose -f docker-compose.local.yml up -d

The compose file namespaces everything under zeq-local so it coexists with other projects on your machine. The stack binds:

Service	Port	Role
api-server	3010	REST API + static `/sdk/` + `/apps/`
postgres	5432	tenant + key + usage store
docs	3011	Docusaurus dev server (optional)

Open http://localhost:3010/sdk/ to confirm the new IA serves.

Bare-metal

# 1. Install deps (Node 20+, pnpm, Postgres 16)
corepack enable && corepack prepare pnpm@latest --activate
brew install postgresql@16                # or apt equivalent

# 2. Clone + install
git clone https://github.com/hulyasmath/zeq-framework
cd zeq-framework
pnpm install

# 3. DB + envs
createdb zeq_local
cp .env.local.example .env.local
# edit DATABASE_URL + ZEQ_KEY_SALT in .env.local

# 4. Migrate + run
cd app/artifacts/api-server
pnpm migrate
pnpm dev                                   # :3010

Cloud

Any container host works. The api-server is a single Node process + a Postgres dependency. Recommended envs:

Var	Purpose
`DATABASE_URL`	Postgres connection string
`ZEQ_KEY_SALT`	salt for API-key hashing (rotate on compromise)
`ZEQ_JWT_SECRET`	session signing secret
`ZEQ_MAIL_PROVIDER_KEY`	optional — only if using Zeq Mail

Scale horizontally by running multiple api-server instances behind a load balancer; each instance is stateless apart from DB. The HulyaPulse is derived from Unix time, so every replica phase-aligns automatically.

Point SDKs at your node

// TypeScript
const zeq = new ZeqClient({ apiUrl: "https://zeq.yourco.com" });

# Python
zeq = ZeqClient(api_url="https://zeq.yourco.com")

# MCP
ZEQ_API_URL=https://zeq.yourco.com zeqsdk-mcp

Verify

Smoke test after startup:

curl http://localhost:3010/api/health
curl -X POST http://localhost:3010/api/playground/compute \
  -H "Authorization: Bearer demo-key" \
  -H "Content-Type: application/json" \
  -d '{"operators":["KO42","ZRO00"],"inputs":{"unix_time":1798346820}}'

Expect HTTP 200 and a response carrying "domain": "Zeq Resonance Theory" entries in operatorObjects.

Quickstart — Docker Compose​

Bare-metal​

Cloud​

Point SDKs at your node​

Verify​

See also​

Quickstart — Docker Compose

Bare-metal

Cloud

Point SDKs at your node

Verify

See also