Skip to content

docs: explain package variants in install.md #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
renecannao merged 1 commit into from
Apr 16, 2026
+10 −0
Merged

docs: explain package variants in install.md #95

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ For production deployments, see [Orchestrator deployment](deployment.md). The fo
The following assumes you will be using the same machine for both the `orchestrator` binary and the MySQL backend.
If not, replace `127.0.0.1` with appropriate host name. Replace `orch_backend_password` with your own super secret password.

#### Which package do I need?
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This new section provides a clear explanation of the package variants. However, it introduces redundancy with the existing text at the end of the document (lines 93-95), which also describes the requirements for CLI vs. Web UI modes. To maintain a single source of truth and improve document flow, consider removing or consolidating the redundant text at the end of the file.


Each release publishes three package variants (as `.deb`, `.rpm`, and `.tar.gz`, for both `amd64` and `arm64`):

- **`orchestrator`** — the full server install. Contains the `orchestrator` binary, the web UI resources, sample config files, and the systemd unit. This is what you want on the host(s) that will run the `orchestrator` service with the HTTP API and web interface.
- **`orchestrator-cli`** — the `orchestrator` binary only. Pick this when you want to run `orchestrator` from the command line (CLI mode) or as an HTTP API server without the web UI, and you do not need the sample configs or systemd unit.
- **`orchestrator-client`** — a thin bash wrapper around the HTTP API (see [orchestrator-client](orchestrator-client.md)). It is a single shell script that depends on `jq`; install it on ops/app boxes that need to talk to an already-running `orchestrator` service without shipping the Go binary. Because it is shell-only, the package is only a few KB — that is expected.
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The orchestrator-client script relies on curl to interact with the orchestrator API, in addition to jq for parsing responses. Mentioning curl as a dependency ensures users are aware of all necessary tools for the client to function correctly.

Suggested change
- **`orchestrator-client`** — a thin bash wrapper around the HTTP API (see [orchestrator-client](orchestrator-client.md)). It is a single shell script that depends on `jq`; install it on ops/app boxes that need to talk to an already-running `orchestrator` service without shipping the Go binary. Because it is shell-only, the package is only a few KB — that is expected.
- **`orchestrator-client`** — a thin bash wrapper around the HTTP API (see [orchestrator-client](orchestrator-client.md)). It is a single shell script that depends on `jq` and `curl`; install it on ops/app boxes that need to talk to an already-running `orchestrator` service without shipping the Go binary. Because it is shell-only, the package is only a few KB — that is expected.


If you are unsure, install `orchestrator`.

#### Extract orchestrator binary and files

- Extract from tarball
Expand Down
Loading