On this page
Status: Supported. Use this when you need an unreleased change, a custom build, or a contributor checkout. For normal use, prefer Native binaries or Docker.
Prerequisites#
- Linux or macOS.
- Rust toolchain from
rust-toolchain.toml(currently channel1.99.0, componentsrustfmt+clippy) —rustupinstalls the pinned toolchain automatically. psqlor another PostgreSQL client for verification.
Build#
git clone https://github.com/plomid/plomid.git
cd plomid
cargo build -p plomid-server # server binary → ./target/debug/plomid-server
cargo build -p plomid-cli # management CLI → ./target/debug/plomid
cargo build --release -p plomid-server # optimized binary → ./target/release/plomid-serverRun#
./target/release/plomid-server --data ./data --host 127.0.0.1 --port 5432 \
--username plomid --password "$PLOMID_PASSWORD"
psql "postgresql://plomid:$PLOMID_PASSWORD@localhost:5432/plomid" -c "SELECT version();"For day-to-day development, ./start.sh wraps the debug build with loopback-friendly defaults (PLOMID_DATA_DIR, PLOMID_HOST, PLOMID_PORT, PLOMID_USER, PLOMID_PASSWORD, PLOMID_LOG_LEVEL overrides supported). It binds 0.0.0.0 by default with the explicit plaintext opt-in — development only.
Quality gates (contributors)#
cargo build --workspace
cargo fmt --check
cargo clippy --workspace --all-targets -- -D warnings
make test-ci
cargo deny checkmake test-ci (fast unit + bounded integration tiers) is the routine gate and must finish within the CI job budget; scale/soak/benchmark workloads are #[ignore]-gated and run only via make test-scale or nightly CI. See Contributing.
Cross-builds and packaging#
| Target | Command |
|---|---|
| Server binary (this host) | make release |
| Linux binary (amd64 / arm64) | make linux-binary / make linux-binary-all |
| Runtime Docker image | make docker |
macOS tarball + .dmg |
make package-mac (needs Xcode tools) |
Releases are cut with make release-beta VERSION=<x.y.z>, which runs every gate before tagging.
Troubleshooting#
| Symptom | Fix |
|---|---|
| Toolchain mismatch | rustup show — the pinned channel in rust-toolchain.toml wins; update rustup. |
plomid-server was not found beside ... |
Build plomid-server first; plomid server start looks for a sibling binary. |
| Disk exhaustion during tests | du -sh target, clear it, sweep leaked plomid-* scratch dirs from $TMPDIR. |
Next: Quickstart.