Alternative Installation Methods
Run the Docker image from the GitHub registry, mounting the node's data directory into your home directory and using the host network. (Replace
%USERPROFILE% on Windows or
$HOME on others)
docker run --rm --tty --interactive --network host --volume <home-directory>/.ironfish:/root/.ironfish ghcr.io/iron-fish/ironfish:latest
Now check the status of your node using IPC, again replacing
<home-directory> according to your OS.
docker run --rm --tty --interactive --network host --volume <home-directory>/.ironfish:/root/.ironfish ghcr.io/iron-fish/ironfish:latest status -f
--network host is needed for 2 Docker containers to connect over IPC.
Note: You can also use the RPC layer over TCP by starting your node with
--rpc.tcp, which connects over the default port 8020.
To update your image, use
docker pull before running the image.
docker pull ghcr.io/iron-fish/ironfish:latest
Install from source
First, head over to GitHub to clone our official repository. Once that's done, follow the initial setup steps in the README to install prerequisites, then head to the CLI README to run the CLI.
Install via Homebrew
Note: Our Homebrew tap does not yet support Apple Silicon/arm64. We recommend installing Iron Fish using NPM. You can also install Iron Fish from the source or use Docker with
Start by adding our Homebrew tap and installing Iron Fish.
brew tap iron-fish/brew && brew install ironfish
You're all set! Run the Iron Fish CLI:
When updates are available, update Brew, then reinstall Iron Fish.
brew update && brew uninstall ironfish && brew install ironfish