Links
Comment on page

Getting Started — Requirements

The information below, and over the next pages, is only for the On-Premise version of HollaEx.
To avoid having to host the exchange on your teams hardware, and deal with the technical background, please look into our offered Cloud plans.
Welcome to these docs on how to become a HollaEx exchange operator!
Within the next hour or two you could have users on your exchange trading and making a profit for you, simply follow the process over the next few pages!
Let's start with the equipment and software we are going to be working on. The list below shows the requirements needed for a hassle-free HollaEx On-Premise process, with details on each below.

HollaEx Dashboard Account 🎛️

The HollaEx Dashboard constitutes one of the two halves of your HollaEx Exchange operator experience (the other being the exchange itself). The Dashboard is the very first step and will let you make the first few decisions.
Simply head on over to the HollaEx dashboard, make an account, and follow the five-step wizard to get going.
For a little extra help going through these steps, please check out the page below:

System Requirements 🖥️

If you are going to run the HollaEx Kit on the public cloud, you don't need to go through the preparation parts. HollaEx provides a simple and easy marketplace image. Visit the HollaEx Blog to see more details. HollaEx is available both on AWS Marketplace and DigitalOcean Marketplace. Start your instance with all dependencies installed right away!
The system here refers to the machine that will have the HollaEx files on. Bear in mind, that this machine will also be the machine that will act as the server for the website when the time comes to actually host it.
Notice that for the system requirements below we have two tabs, Single Host and Kubernetes.
This refers to the method by which our exchange will be hosted, in most cases Single Host will suffice, and is the most straightforward method.
Kubernetes is a slightly more involved process that does come with benefits for ensuring continual operation. If you want to use Kubernetes over the more conventional setup, jump over to these docs to learn the slightly different setup process.
Single Host
Kubernetes
  • Debian-based Linux (Ubuntu), RHEL (CentOS),
    • Or macOS with Bash shell (check the section below).
    • Or Windows 10 2004 or higher with WSL 2 Enabled (check the section below).
  • Minimum 2vCore CPU, 8GB RAM.
  • Minimum 50GB of Free Disk Space (SSD recommended).
  • Client Computer
    • Debian-based Linux (Ubuntu), RHEL (CentOS), or macOS with Bash shell.
  • Host Kubernetes Server
    • Kubernetes v1.19 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.

Operating Systems ⚙️

The choice of the operating system of the machine being used can make the process of running the HollaEx Kit, slightly more tricky. We have three choices, from easiest to most tricky:

Debian-Based Linux Distros 🐧

A Debian-based Linux OS is by far the simplest, and thus the most strongly recommended route to take with HollaEx.
With Linux, most of the packages we need will be automatically installed, and we don't have to fret too much about compatibility. You can move right on to the next section if this is what you will be using.

macOS 🍏

macOS is a Unix-compliant operating system which means it integrates with the HollaEx Kit well.
There are a few prior steps we need to take so that some of the software HollaEx requires is on the machine, as the CLI won't be able to install it itself.
Check the page below for the steps on getting your macOS machine ready for HollaEx:

Windows 🪟

Despite being a very common OS, Windows is not a Unix complaint. This does make it a little more difficult to make it play nice with HollaEx.
Fortunately, Microsoft has released a tool that will let you emulate a Linux environment on your Windows machine, WSL2.
Whilst this will work fine, and is great for those wanting to test out HollaEx on their Windows machine, due to the added complexity it is not recommended for use in a live, production exchange.
See the page below to learn how to install WSL2, the tool needed, and the steps to get HollaEx on Windows:

Software Packages 🧩

Like all modern software, HollaEx utilizes a variety of packages The vast majority of these will be included. Of particular importance are docker, docker-compose, and jq. Thankfully, the CLI installer supports Debian-based distributions (apt-get), CentOS, or RHEL (yum) on Linux and will be able to install these automatically.
For the macOS and Windows cases, please check their specific pages above.
If in the case that you run into errors throughout the process that like similar to the image below.

Production Prerequisites 🌐

The production prerequisites below are simply the other services you will need to get the exchange live on the internet, with email and security.
For the moment these aren't vital until we get to the Production step in these docs, so if you want to get the machine on your machine and just test and play around locally, feel free to come back to these later.