ErgoSphere was created in the image of Umbrel (https://getumbrel.com), which allows the easy setup of self-hosted Ergo services.

DISCLAIMER: This is experimental software, so do not use it with funds that you cannot afford to lose.

An Ergo full node gets installed by default, which serves as the foundation for other services.

Currently the following services are available on ErgoSphere:

• Ergo explorer (currently not working)
• ErgoMixer
• ErgoDex offchain execution

This list is to be expanded with more services in the future.

ErgoSphere is written in Java, and therefore can run on any system with a Java environment, however there are some additional dependencies:

• Java >= 1.8
• Docker
• Docker-compose (comes with Docker on Windows)
• SBT

ErgoSphere must be ran with administrative privilages. This is to make sure there won't be permission problems when interacting with Docker or PowerShell.

By default the web interface will be available on the local IP address of the host (e.g: 192.168.50.111), and all data will be stored in the "data" folder.

NOTE: all other services will be available on this address on their respective ports

These default can be overwritten with command line parameters:

--address <IP ADDRESS>
--port <PORT NUMBER>
--storage <DATA DIRECTORY>

An example for using custom parameters would look like this:

java -jar ErgoSphere.jar -a 192.168.0.120 -p 5555 -s ESdata/

In this example the web interface will be accessible on http://192.168.0.120:5555, and all data will be stored in the "ESdata" folder.