Build Ferry

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

Dashboard. npm writes the dashboard to web/dist. This step is optional.

1 / 3

Terminal

cd web && npm ci && npm run build && cd ..

ferry-api embeds web/dist when it compiles.

Terminal

cargo build

cargo makes a debug build: target/debug/ferryd and target/debug/ferry.

A release build

Terminal

cargo build --release

A release build puts the programs in target/release/.

What you need

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

Start the server

ferryd run keeps the server in the foreground. You see its log, and Ctrl+C stops it.