docs.rs failed to build alopex-server-0.6.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build:
alopex-server-0.5.0
alopex-server
Alopex DB server providing HTTP and gRPC APIs for SQL execution, vector search, and session-aware transactions.
Features
- HTTP JSON API for SQL, vector search/upsert, and session control
- gRPC API with streaming SQL results
- Prometheus-compatible metrics and health checks
- TLS and optional API key authentication
- Audit logging for DDL and config changes
Quick start
Default bindings:
- HTTP:
127.0.0.1:8080 - Admin:
127.0.0.1:8081 - gRPC:
127.0.0.1:9090
SQL over HTTP
Vector search
Configuration
The server loads configuration from alopex.toml (current directory) or an explicit path.
Environment variables use the ALOPEX__ prefix.
Example alopex.toml:
= "127.0.0.1:8080"
= "127.0.0.1:9090"
= "127.0.0.1:8081"
= ""
= "30s"
= 104857600
= 104857600
= 1000
= "300s"
= true
= true
= true
= { = "none" }
# auth_mode = { type = "dev", api_key = "secret" }
# tls = { cert_path = "./server.crt", key_path = "./server.key", ca_path = "./ca.crt", min_version = "tls13" }
# audit_log_output = { type = "file", path = "./audit.log" }
Admin endpoints
GET /healthz- health checkGET /status- runtime statusGET /metrics- Prometheus metrics
For a full configuration guide and API reference, see docs/server-guide.md.