What you need

You need Rust and Docker for the server, and Node.js for the dashboard and the docs.

Rust compiles ferryd, ferry and each crate.

1 / 4

The tools

Tool	Version	Use
Rust	1.89 or newer (edition 2024)	`ferryd`, `ferry` and each crate
Docker	Docker Desktop on macOS works	To run `ferryd` and the end-to-end tests
`git` and `docker` CLIs	On the PATH	Builds: `ferry-build` runs them
Node.js	20.19 or newer, with npm	The dashboard (`web/`) and the docs (`docs/`)

Development setup

Ferry is one repository with three projects. Build it from source, run it, then follow the rules for a change.

Build Ferry

Build the dashboard first. Then cargo builds the server and the CLI.