slater

(★ 101)

Low-memory graphdb with Bolt+tls support, at-rest encryption & vectors designed for local replica graph use cases.

  • .dockerignore
  • .gitignore
  • acl.json
  • Cargo.lock
  • Cargo.toml
  • config.json
  • CONTRIBUTING.md
  • docker-compose.yml
  • Dockerfile
  • Dockerfile.lite
  • DOCKERHUB.md
  • LICENSE
  • NOTICE
  • README.md
  • rust-toolchain.toml
  • SECURITY_WORKLIST.md
  • THREAT_MODEL.md

# Installation Guide

1. Get the code
git clone https://github.com/Hikari-Systems/slater

Downloads the entire project code from GitHub to your computer.

cd slater

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker pull hikarisystems/slater:latest

Type this command into your terminal and run it.

docker run --rm -v slater-data:/data -v "$PWD/dumps:/dumps:ro" \

Runs the built image as an actual container.

docker run -d --name slater -p 7687:7687 \

Runs the built image as an actual container.

docker compose build

Runs the command against the services defined in the compose file.

docker compose up slater

Builds and starts all defined containers (server, database, etc.) at once, in the background.

Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
pip install -r perf/loadtest/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

Runs the Python script (or module).

If it runs without errors and prints output in the terminal, it worked.

4. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
export PATH="$HOME/.cargo/bin:$PATH"

Type this command into your terminal and run it.

cargo build

Compiles the Rust project.

cargo test # unit + the bounded-RSS headline integration test

Type this command into your terminal and run it.

cargo clippy --all-targets -- -D warnings

Type this command into your terminal and run it.

cargo fmt --all -- --check

Type this command into your terminal and run it.

If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation