A quick start guide on how to run a ConsenSource node locally on macOS for development purposes.


The following tools are required to run ConsenSource locally:

  • Docker - brew install docker

If you wish to perform development work, the following additional tools are required:

How To Run ConsenSource

  1. Clone the ConsenSource repo
    • Via HTTPS: git clone consensource
    • Via SSH: git clone consensource
  2. cd consensource
  3. Pull down Docker images from DockerHub
    • docker-compose pull(the images are quite large and will take some time to download)
  4. Start the network
    • docker-compose up

Available Services

The following services should be available on your local machine at this point:

You can run the following cURL command to see the contents of the genesis block that was created on startup:

curl -X GET http://localhost:8008/blocks

Log In To A Container

To log in to a running container for any of the services, you can run:

docker exec -it <container_name> /bin/bash

For example, to log in to the CLI, you can run:

docker exec -it consensource-cli /bin/bash

Last modified April 14, 2020: Additonal UI docs (9651d07)