Reference
Configuration
Everything is configured through environment variables, so the same image behaves identically in compose, Kubernetes, or a bare systemd unit.
Networking#
| Variable | Default | Notes |
|---|---|---|
CROWKIS_BIND_ADDR | 127.0.0.1 | Address Docker publishes ports on. Localhost by default, on purpose. |
CROWKIS_BIND_HOST | 0.0.0.0 | Bind address inside the container, so Docker port mapping works. |
CROWKIS_BIND_PORT | 6383 | RESP port. The dashboard runs on port + 1, gRPC on port + 2. |
CROWKIS_MAX_CONNECTIONS | 10000 | Concurrent connection ceiling. |
Authentication#
| Variable | Notes |
|---|---|
CROWKIS_AUTH_TOKEN | Bearer token for RESP and gRPC. Compared in constant time. Set it before exposing either port. |
CROWKIS_ADMIN_KEY | Key for the management API and dashboard metrics. Mandatory once you bind beyond loopback. |
CROWKIS_ALLOW_UNAUTHENTICATED_ADMIN | Local development escape hatch. Never set it on a shared or public host. |
Public-bind hardening is enforced in the server: if Crowkis detects a non-loopback deployment, management and dashboard metrics require auth by default — misconfiguration fails closed, not open.
Memory and capacity#
| Variable | Default | Notes |
|---|---|---|
CROWKIS_MEMORY_LIMIT | 512m | Runtime memory ceiling for the cache process. |
CROWKIS_BLOCK_CACHE_BYTES | 64m | Block cache for hot SSTable reads — your read-path accelerator. |
The storage engine itself manages a 64 MB memtable that flushes to SSTables, with L0→L1→L2 compaction, bloom filters (~1% false positives), and LZ4 block compression. Durability comes from a write-ahead log with CRC32-checked records.
Logging and privacy#
| Variable | Default | Notes |
|---|---|---|
CROWKIS_LOG_QUERY_PREVIEWS | 0 | Prompt previews stay out of logs unless you explicitly opt in. Privacy is the default. |
Logs are structured JSON on stderr, with rotation configured in the default compose file.
License#
.env
CROWKIS_LICENSE_PATH=/etc/crowkis/license.json CROWKIS_LICENSE_PLAN=Community CROWKIS_LICENSE_CUSTOMER=Local workspace
No license file means Community edition — the full engine with a soft 100K-entry cap and up to 3 tenants. A valid Ed25519-signed license unlocks Enterprise at boot; an invalid signature refuses to start; an expired license degrades gracefully through a 14-day grace period.