Docker containers for Bee are hosted at Docker Hub for your convenience.
If running a Bee full node, it is recommended that you make use of
Ethereum's external signer, Clef. Skip
ahead if you are comfortable with
docker basics for instructions on
how to use docker-compose
to easily set up Bee with persistent storage and integration with the
Bee Clef container.
Try Bee out by simply running the following command in your Terminal.
If starting your node for the first time, you will need to deploy a chequebook contract. See Manual Installation for more info.
To persist files, mount a local directory as follows and enter the
password used to encrypt your keyfiles. Note,
docker insists on
absolute paths when mounting volumes, so you must replace
/path/to/.bee-docker with a valid path from your local filesystem.
Once you have generated your keys, leave Bee to run in the background...
In order to avoid accidentally upgrading your Bee containers, or deadlocks resulting from Docker caching solutions, it is recommended to use best practices and pin the specific version of Bee that you want to run.
You may use the tags
stable, or find out more
at the Docker Hub repository.
Configuration files for Bee and Bee Clef are provided to enable quick and easy installation of both programs with persistent storage and secure secret management. To install Bee without Clef, simply omit the relevant steps.
First, retrieve the current
Next, create a
.env file using the example file provided. This file will be responsible for storing configuration and secrets for our Bee and Bee Clef applications.
There are some important configuration parameters which must be set in order for our projects to work. To affect configuration in the
.env file, we first remove the
# at the beginning of the line and then change the value after
= to our desired config.
For Bee, amend the following parameters:
To enable Clef support on mainnet, we must also change the following params:
For testnet, use chain id
With the configuration settings complete, you can start your Bee and Clef nodes by running:
By specifying the
-d flag to
docker-compose we run Bee and Bee Clef as a daemon.
Docker Compose will create a Docker Volume called
bee containing important key material. Make sure to backup the contents of your Docker volume!
To determine the Bee node's address to fund, we can check the logs for our Bee container:
Once you have determined your Bee's Ethereum addresses, fund your node.
After your transaction has been completed, your node should recognise that your wallet has been funded, and begin to deploy and fund your Bee chequebook!
Once Bee has completed this procedure, you may query the Bee HTTP API at
Once you start seeing messages in the
docker-compose logs -f bee-1
You're connected to the Swarm. Let's do a quick check to find out how
many peers we have using the
curl command line utility:
If you see peers listed here - congratulations! You have joined the swarm! Welcome! 🐝