Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

There are several ways to install job-orchestrator depending on your needs.

From crates.io

The easiest way to install job-orchestrator is via Cargo:

cargo install job-orchestrator

From Source

Clone the repository and build:

git clone https://codeberg.org/rvhonorato/job-orchestrator.git
cd job-orchestrator
cargo build --release

The binary will be available at target/release/job-orchestrator.

Using Docker

Pull the pre-built image:

docker pull codeberg.org/rvhonorato/job-orchestrator:latest

Or build locally:

docker build -t job-orchestrator .
# example client (job-orchestrator + gdock), built on top of the local image
docker build --build-arg BASE_IMAGE=job-orchestrator -t job-orchestrator-client example/

Prerequisites

For Building from Source

  • Rust: 1.88 or later (edition 2024, uses let chains)
  • C compiler: SQLite is compiled from source and linked statically (via sqlx’s bundled SQLite), so no system SQLite library is needed

On Debian/Ubuntu:

apt-get install build-essential

For Running

  • Linux or macOS: client mode runs jobs with bash and manages them with the kill command, so both must be on PATH. Windows is not supported for client mode
  • Filesystem access: Write permissions for database and job storage directories

Verifying Installation

After installation, verify it works:

job-orchestrator --help

You should see the server and client subcommands listed. There is no --version flag.

Next Steps