Warnet requires either Kubernetes or Docker to be installed in order to run the network. Instructions for both can be found below.
Install kubectl (or equivalent) and
configure your cluster. This can be done locally with minikube or using a
managed cluster.
Install docker engine and its compose plugin for your system: https://docs.docker.com/engine/install/
e.g. For Ubuntu:
# First uninstall any old versions
for pkg in docker.io docker-doc docker-compose podman-docker containerd runc; do sudo apt-get remove $pkg; done
# Add Docker's official GPG key:
sudo apt-get update
sudo apt-get install ca-certificates curl gnupg
sudo install -m 0755 -d /etc/apt/keyrings
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
sudo chmod a+r /etc/apt/keyrings/docker.gpg
# Add the repository to Apt sources:
echo \
"deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
"$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | \
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update
# Install the docker packages and docker compose plugin
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-pluginIf you have never used Docker before you may need to take a few more steps to run the Docker daemon on your system. The Docker daemon MUST be running before stating Warnet.
On macOS, a bridge to the docker subnet is required, such as https://github.com/chipmk/docker-mac-net-connect
# Install via Homebrew
brew install chipmk/tap/docker-mac-net-connect
# Run the service and register it to launch at boot
sudo brew services start chipmk/tap/docker-mac-net-connectgit clone https://github.com/bitcoin-dev-project/warnet
cd warnetpython3 -m venv .venv # Use alternative venv manager if desired
source .venv/bin/activatepip install --upgrade pip
pip install -e .