System Installation
RetractorDB’s primary deployment platform is Linux on x86-64 and ARM64 (AArch64). You can install a release package or build the programs from source. The installer downloaded with curl installs prebuilt binaries; compilation is a separate operation. Apple is a development environment, covered in a separate section.
Choosing an installation method
| Method | Use | Binary location |
|---|---|---|
Installer install.sh --user | Installation for the current user, without administrator privileges | ~/.local/bin |
Installer install.sh --system | System-wide installation, optionally with a systemd service | /usr/local/bin |
| DEB package | Debian or Ubuntu; managed through apt | /usr/bin |
| Building from source | Development, testing, or your own release | ~/.local/bin by default |
The installer uses GitHub Releases. A quick installation guide is also available on the project website. The production-build contract and diagnostic variants are described in the build appendix.
Engine executes a plan inside Python on a logical timeline. It provides no real-time execution and publishes no streams on the bus. Use xretractor for real-time processing and the monitoring client to observe its streams.
Reading paths
- Linux releases: portable, DEB, systemd, upgrades and configuration.
- Building from source: Linux and the macOS development port.
- Running: standalone and a running service plan.
- Python and Jupyter: wheels, Colab and local environments.
- Building the Python library: RDB_PYTHON, tests and packaging.