Before you start, Please make sure to configure your exchange through the bitHolla Dashboard. Check the Before you start section of docs.
Debian-based Linux (Ubuntu), RHEL (CentOS), or macOS with Bash shell.
Or Windows 10 2004 or higher with WSL 2 Enabled.
Minimum 2vCore CPU, 4GB RAM.
Minimum 50GB of Free Disk Space (SSD recommended).
Latest docker
and docker-compose
.
JSON Parser jq
(download).
Make sure your system meets the requirements above otherwise, you might run into unexpected issues.
Client Computer
Debian-based Linux (Ubuntu), RHEL (CentOS), or macOS with Bash shell.
Or Windows 10 2004 or higher with WSL 2 Enabled.
Host Kubernetes Server
Kubernetes v1.16 or Higher.
Recommended to have 3 worker nodes at least.
Recommended 2vCore CPU, 4GB RAM per worker node.
Recommended to have 30GB of Free Disk Space per node.
Make sure your system meets the requirements above otherwise, you might run into unexpected issues.
bitHolla account
Your exchange created and configured through the bitHolla Dashboard
For Production
Your own domain
Amazon AWS (Recommended for hosting)
SMTP for email service
Google reCaptcha Account for security
Your own Docker registry e.g. Docker Hub (Optional)
You can download the Kit through Git from the HollaEx Kit GitHub repository. Clone the repository either directly through your web browser or by using the git
command below:
git clone https://github.com/bitholla/hollaex-kit.git
HollaEx Kit is a full package with the necessary directory structure, templates, and even a full web server for a HollaEx Exchange.
Always keep the HollaEx Kit folder safe. It has all the information related to your exchange. You'll lose control of your exchange If you lose or damage the folder.
The first step is to install HollaEx CLI, a Command-Line tool that simplifies the operation of your HollaEx Kit. You should go into the HollaEx Kit path first to run any further commands.
cd hollaex-kit
Run the CLI installer by using the command below.
bash install.sh
Starting from the HollaEx Kit version v1.0.3, the installer will automatically install
docker
,docker-compose
, andjq
if you don't have them already on you machine. Currently the installer is only supporting Debian (Ubuntu) based distros withapt-get
for the installation.
Once the installation is completed, type hollaex version
on your terminal to make sure HollaEx CLI is set correctly.
Once everything is done, it's time to set up your exchange!
Please proceed to the Setup section next.
HollaEx Kit is designed for Unix since most professional servers are running on a Unix-based system. However, don't worry! We understand that and this windows guide is here to help.
Thanks to Microsoft, they recently released a cool technology called WSL 2 (Windows Subsystem for Linux 2), which allows Linux application works on native Windows.
Here we guide you on how to get started on your Windows Environment by using WSL 2 and Ubuntu.
WSL 2 is still a "fast ring" feature of Windows. To enable it, You should install the fast ring version of Windows by joining the Windows Insider Program. The fast ring version of Windows could cause some unexpected issues in the future. Please keep that in mind before proceeding.
You can follow this document by Microsoft to enabled WSL 2 on your Windows PC.
You can download Ubuntu at Microsoft Store after enabling the WSL 2.
The software mentioned below are dependencies that should be manually installed on your Ubuntu environment.
Latest docker
Latest docker-compose
Once WSL 2 and Ubuntu are fully set on your computer, You can go back to our general document and proceed to get HollaEx Kit for your exchange.
Keep that in mind that HollaEx on Windows is still only recommended for testing purposes. If you are considering to build a production-ready exchange, Please choose Linux.
HollaEx is compatible with the Unix environment. Since macOS is the Unix, there are no difficulties to run the HollaEx on macOS. But, the auto dependencies installer would not work for macOS. This page describes a way to install the required dependencies on your Mac.
Software mention below are dependencies that should be manually installed on your Mac.
Latest docker
Latest docker-compose
Homebrew (Package Management Software) - To install jq
You can follow this document to install Docker and Docker compose on your Mac.
After done with the installation, you need to increase the memory through Docker Preferences since Mac OS restricts memory usage.
Click the Docker menu in the top status bar and select Preferences.
Go to Resources and increase Memory to 4GB manually, and click the "Apply&Restart" button.
The most efficient way to install jq on a Mac would probably be using homebrew. Follow the simple step below to install brew on your Mac.
Open the Terminal application, and then enter the following command into a single line
ruby -e "$(culr -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
Enter the administrator password to begin installation (It would take a while depending on the speed of your Mac and internet connection). You will see the "Installation successful!" message once completed.
Start installing jq
by typing the command below:
brew install jq