FerryDocs
ContributingDevelopment setup

Start the server

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

Edit on GitHub
Terminal
./target/debug/ferryd run --data-dir ./ferry-data
loglogferryd runforegroundYour terminalthe log, Ctrl+Cferrydbackgroundferryd.logferryd logs -f

With run, the server keeps the terminal. The log is in front of you, and Ctrl+C stops the server.

1 / 2

What the server prints

ferryd prints the URL of the . While the server has no , it also prints the Create your account link.

Open the link one time. It creates the account that you use to sign in to the dashboard.

The data directory

./ferry-data is the default . git ignores it.

FileUse
ferry-data/api_tokenThe , for the commands of the next page
ferry-data/ferryd.logThe log of a server in the . Read it with ferryd logs -f.

More detail in the log

Set the variable RUST_LOG before you start the server. The default level is info.

ValueResult
RUST_LOG=debugMore detail from each crate
RUST_LOG=ferry_engine=debugA filter: more detail from one crate

On this page