Documentation
Documentation
Documentation for Scalaxy developers and maintainers.
Welcome to the Scalaxy documentation. Pick a section below, or browse the sidebar.
- Getting started: install, run your first node, and build the project.
- Graph & Cypher: the property-graph layer, the openCypher language,
its conformance result, and the shipped benchmark datasets.
- Architecture: how the ring, replication, S3-backed lazy storage,
aggregate summaries, and console fit together.
- Scaling & elasticity: adding nodes, presence repair, aggregate
summaries, read fan-out, and monitoring.
- S3 object storage: packed segments, local persistent cache,
sidecar metadata, aggregate summaries, encryption at rest, and re-homing.
- Reference: the wire protocol, the REST API, and the Lisp client.
- Operations: deployment, Kubernetes, health, encryption, and troubleshooting.
- Maintainers: releasing, CI, and project governance.
Install, build, and run your first Scalaxy node.
guide
How the ring, replication, storage, and console fit together.
guide
The binary wire format shared by the data plane and durability log.
reference
The property-graph layer over the replicated store.
guide
The openCypher language: coverage, certification, and access points.
reference
Movie Graph and NYC taxi datasets with reference timings.
reference
The HTTP API behind the web console: keys, status, health, console.
reference
Talk to Scalaxy from Lisp, curl, or your own language.
reference
Compile with ASDF and run the 9,018-check test suite.
guide
Docker, docker-compose, and the SCALAXY_* configuration reference.
ops
Run a replicated cluster as a StatefulSet with PVCs and probes.
ops
Health checks, failure behavior, durability, and troubleshooting.
ops
How to contribute code, documentation, and reports.
community
Releasing, CI, and governance for maintainers.
maintainers