Getting startedInstallation
Build from source
Four steps make the two programs, ferryd and ferry, from the Ferry repository.
Get the code
git clone https://github.com/Carter2307/ferry
cd ferryBuild the dashboard
(cd web && npm ci && npm run build)npm writes the dashboard to web/dist. The Rust build puts this folder into ferryd. Thus you must build the dashboard first.
Build the programs
cargo build --releasecargo makes target/release/ferryd and target/release/ferry.
Put the programs on your PATH
sudo install -m 0755 target/release/ferryd target/release/ferry /usr/local/bin/This step is optional. Without it, type ./target/release/ferryd and ./target/release/ferry.
What you have now
ferryd
ferry
The other pages name the programs ferryd and ferry. The PATH lets you type these short names.
ferryd compiles without Node.js. Then the page at / is a placeholder that tells you how to build the dashboard. The REST API and the CLI work normally.
You can build the dashboard later and not compile the server again. Start ferryd with FERRY_UI_DIR=/path/to/web/dist.