Skip to main content

Install Commune

Setting Up With setup.py​

Install setuptools: If you haven't already installed setuptools, you can do so using pip:

pip install -r requirements; pip install -e .

or

./start.sh

Setting Up Commune With Docker​

Install Docker: If you don't have Docker installed on your system, download and install it from the official Docker website: https://www.docker.com/get-started.

Clone the Commune Repository: Open your terminal or command prompt and clone the Commune repository from GitHub:

make up 

or

docker-compose build

Start Commune: Once the Docker container is built, start Commune by running the following command:

make start

or

docker-compose up -d # -d for detached mode

To enter the docker container do, and do the following

make enter

or

docker exec -it commune bash

Then run the following command to sync the network

c ls

To exit the container

exit

Sync Commune with the Network: Inside the Docker container, run the following command to sync Commune with the network:

c sync

Congratulations! Commune is now set up and running inside a Docker container.

Note:​

This repo is on the cutting edge of experimentation, so there may be some hiccups along the way. If you're primarily interested in using the core features of the protocol (such as intuitive cli) or seeking a more lightweight implementation, consider installing the Communex package.