Skip to content
Vaylix logo Vaylix logo Vaylix Docs

Build from Source

Use this path only when you need local development, code changes, or behavior that has not been cut into a tagged release yet. The operational docs assume the published server image and a downloaded client binary.

Requirements

Section titled “Requirements”
  • Rust toolchain for the Vaylix workspace

Build the Workspace

Section titled “Build the Workspace”

From the Vaylix project root:

Terminal window
cargo build --workspace

Release binaries:

Terminal window
cargo build --release -p server
cargo build --release -p client

Validate the Workspace

Section titled “Validate the Workspace”
Terminal window
cargo fmt --check
cargo clippy --workspace --all-targets --all-features -- -D warnings
cargo test --workspace
cargo audit

Run from the Source Tree

Section titled “Run from the Source Tree”

Server:

Terminal window
cargo run -p server -- \
  --bind 127.0.0.1 \
  --port 9173 \
  --user vaylix \
  --password vaylix

Client:

Terminal window
cargo run -p client -- \
  --url 'vaylix://vaylix:vaylix@127.0.0.1:9173?output=table'

Offline Storage Tooling

Section titled “Offline Storage Tooling”

The vaylix server binary also provides offline storage maintenance and PITR-oriented commands:

Terminal window
vaylix storage verify --data-dir /var/lib/vaylix
vaylix storage migrate --data-dir /var/lib/vaylix
vaylix pitr inspect --data-dir /var/lib/vaylix
vaylix pitr restore \
  --source-dir /var/lib/vaylix \
  --target-dir /tmp/vaylix-restore \
  --to-sequence 1234