Getting startedInstallation
What you need
You need Docker and git to run Ferry, and Rust and Node.js to build it.
To build Ferry, you need Rust and Node.js.
1 / 2
Ferry runs on Linux and macOS.
| Tool | Version | Use |
|---|---|---|
| Docker | Engine 27.3 or newer, or Docker Desktop | Runs everything. Builds use the docker CLI with BuildKit. |
| git | A recent version | Clones repositories for git deploys |
| Rust | Stable 1.89 or newer (install it with rustup) | Builds ferryd and ferry |
| Node.js | 20.19 or newer, with npm | Builds the dashboard |
Your build gets its environment variables as BuildKit secrets (RUN --mount=type=secret,…,env=…). These secrets need Docker Engine 27.3 or newer.
With an older engine, a build that uses environment variables fails. The message tells you to upgrade. See Builds & runtimes.