Running a Node
Linux and Mac instructions for setting up and running on the public Lilypad testnet, including obtaining necessary funds, installing required software, and ensuring security measures.
This process involves configuring your environment, installing necessary software, and ensuring your system meets the prerequisites.
Network information and testnet tokens
The testnet has a base currency of ETH, as well as a utility token called LP. LP is used for both paying for jobs and staking nodes. To add a node to the testnet, follow these steps:
MetaMask
We recommend using MetaMask with custom settings to make things easier. Once you have it installed and setup, here are the settings you need to use:
Network name: Arbitrum Sepolia
New RPC URL: https://sepolia-rollup.arbitrum.io/rpc
Chain ID: 421614
Currency symbol: ETH
Block explorer URL: (leave blank)
For a step by step guide on adding the network, please refer to our Setting up MetaMask documentation.
Fund your wallet with ETH and LP
To obtain testnet LP, use the Lilypad faucet and enter your ETH address.
To obtain testnet ETH, use a third party Arbitrum Sepolia testnet faucet and enter your ETH address.
The Arbitrum Sepolia faucet provides 0.0001 tokens per request. If you need more tokens and already have Sepolia ETH, you can use the official Arbitrum bridge to transfer it over to Arbitrum Sepolia.
The faucet will give you both ETH (to pay for gas) and LP (to stake and pay for jobs).
Prerequisites
Linux (latest Ubuntu LTS recommended)
Nvidia GPU
Nvidia drivers
Docker
Nvidia docker drivers
For a more in-depth look at the requirements to run a Lilypad node, please refer to the hardware requirements documentation.
Installation
To set up your environment for using Lilypad with GPU support, you need to install several key components. This guide will walk you through installing Docker, the Nvidia Container Toolkit, Bacalhau, and Lilypad. You'll also configure systemd to manage these services efficiently.
Install Docker
Docker is a platform that allows you to automate the deployment of applications inside lightweight, portable containers.
To install Docker, follow the steps specific to your operating system from the official Docker documentation.
Install Nvidia Container Toolkit
To ensure proper operation of your graphics cards and Lilypad, follow these steps to install the Nvidia Toolkit Base Installer: Nvidia Container Toolkit download page
Configure the container runtime by using the nvidia-ctk
command:
The nvidia-ctk
command modifies the /etc/docker/daemon.json
file on the host. The file is updated so that Docker can use the NVIDIA Container Runtime.
Restart the Docker daemon:
Install Bacalhau
Bacalhau is a peer-to-peer network of nodes that enables decentralized communication between computers. The network consists of two types of nodes, which can communicate with each other.
To install Bacalhau, run the following in your terminal:
Install Lilypad
The installation process for the Lilypad CLI involves several automated steps to configure it for your specific system. Initially, the setup script identifies your computer's architecture and operating system to ensure compatibility. It will then download the latest production build of the Lilypad CLI directly from the official GitHub repository using curl
and wget
.
Once the CLI tool is downloaded, the script sets the necessary permissions to make the executable file runnable. It then moves the executable to a standard location in your system's path to allow it to be run from any terminal window.
Via official released binaries
Write env file
You will need to create an environment directory for your node.
/app/lilypad/resource-provider-gpu.env
should contain:
This is the key where you will get paid in LP tokens for jobs run on the network.
A WEB3_PRIVATE_KEY
can be retrieved from the Metamask account details menu. For more info, check out this official guide from Metamask on viewing a wallet's private key.
You must not reuse your compute node key as a client, even for testing: this will result in failed jobs and will negatively impact your compute node since the wallet address is how nodes are identified on the network.
Install systemd unit for Bacalhau
systemd is a system and service manager for Linux operating systems. systemd operates as a central point of control for various aspects of system management, offering features like parallelization of service startup, dependency-based service management, process supervision, and more.
To install systemd, open /etc/systemd/system/bacalhau.service
in your preferred editor:
Hint: sudo vim /etc/systemd/system/bacalhau.service
Install systemd unit for GPU provider
Open /etc/systemd/system/lilypad-resource-provider.service
in your preferred editor.
Hint: sudo vim /etc/systemd/system/lilypad-resource-provider.service
Reload systemd's units/daemons (you will need to do this again if you ever change the systemd unit files that we wrote, above)
Start systemd units:
View node status
To check if the node is running use the following command:
This will give a live output from the Lilypad node. The logs will show the node running and accepting jobs on the network.
Run the following command to get more status info from your node:
Please report any issues in the Lilypad Discord.
Disconnecting a node
To disconnect your node from Lilypad you will need to do a few things to completely offboard.
Using sudo rm -rf
is very powerful and can be dangerous if not used carefully. It is highly recommended to navigate to the parent directory and remove files from there to avoid accidental deletion of important files.
First, you must remove the .service
files related to Lilypad and Bacalhau. These files are typically stored in /etc/systemd/system/
. To remove them, run the following command:
Next we notify the systemd manager to reload its configuration by running: sudo systemctl daemon-reload
Then, remove the environment file for the Lilypad resource provider. This file is usually stored in /app/lilypad/
. To remove it, run: sudo rm -rf /app/lilypad/resource-provider-gpu.env
Finally, if you followed the installation instructions from the Lilypad documentation and moved the executable to /usr/local/bin/lilypad
, you can remove it from there. If your executable is stored in a different directory on your machine, you will need to navigate to that directory and remove it from there. To remove the executable, run: sudo rm -rf /usr/local/bin/lilypad
If you want to remove Bacalhau also, run: sudo rm -rf /usr/local/bin/bacalhau
As every system is different, these instructions may vary. If you have any issues, please reach out to the team in the Lilypad Discord for help!
Security
If you want to allowlist only certain modules (e.g. Stable Diffusion modules), so that you can control exactly what code runs on your nodes (which you can audit to ensure that they are secure and will have no negative impact on your nodes), you can do that by setting an environment variable OFFER_MODULES
in the GPU provider to a comma separated list of module names, e.g. sdxl:v0.9-lilypad1,stable-diffusion:v0.0.1
Visit the Lilypad GitHub for a full list of available modules.
Run a node video guide
Windows
Last updated