Skip to content

Installation

Option 1: Binary Download (Linux)

Download the latest release of faucet for Linux from the GitHub Releases page.

FAUCET_VERSION="v1.1.0"

wget https://github.com/ixpantia/faucet/releases/download/$FAUCET_VERSION/faucet-x86_64-unknown-linux-musl -O faucet

# Make the binary executable
chmod +x faucet

# Move the binary to a directory in your PATH (e.g., user local bin)
mv faucet ~/.local/bin

Note: While the binary download is expected to work on most Linux distributions, compatibility is not guaranteed for all systems. If you encounter issues, consider using the Cargo installation or building from source options.

Option 2: Install with Cargo (Linux, macOS, Windows)

Install faucet with Cargo, Rust's package manager.

  1. Install Rust by following the instructions here.
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  1. Install faucet with Cargo.
cargo install faucet-server

Option 3: Build from Source (Linux, macOS, Windows)

  1. Install Rust by following the instructions here.
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  1. Clone the faucet repository.
git clone https://github.com/ixpantia/faucet.git
  1. Build faucet with Cargo.
cargo install --path .