HollaEx®
⚙️ DashboardStart →
  • HollaEx® — The Crypto Exchange Solution
  • ☁️Cloud Operators
    • Launching the Exchange
    • Setting Domain for Cloud Exchanges
    • Easy SMTP for Cloud Exchanges
    • SEO Settings for Cloud Exchanges
      • SEO Advanced Settings
  • ⚙️Operating Your Exchange
    • Operator Control Panel
      • General
      • Users
      • User Profile
      • Assets
      • Markets
      • Stakes
      • Sessions
      • Plugins Apps
      • Trading Fees & Account Tiers
      • Roles
      • Chat
      • Billing
    • Customize Exchange
      • Browser Tools
        • Enter Edit Mode
        • Operator Controls (Visuals)
        • Console
      • Plugins
      • Forked Repo
    • Fiat Controls
      • Initial Setup
      • Setting Up Fiat On/ Off Ramp
      • Editing Deposit & Withdrawal Fees
      • Users Making Fiat Deposit
      • Users Trading With Fiat
      • User Making Fiat Withdrawal
    • Staking
    • OTC Broker
    • P2P
      • P2P Overview
      • P2P Setup
      • P2P Troubleshooting
      • P2P Vendor Flow
    • Smart Chain Trading
    • Assets & Trading Pairs
      • Add New Assets & Trading Pairs
      • Configure Pair Parameters
    • Set up the SMTP Email
      • Set up SMTP with AWS SES
      • Set up SMTP with Mailgun
      • Set up SMTP with SendGrid
      • Test the SMTP with Gmail
    • Enabling reCAPTCHA
    • Email Customization & Audit
    • DeFi Asset Staking Process
  • 🧩Plugins
    • HollaEx Plugins
      • Announcements
      • Bank
      • AWS SNS (Text Messages - SMS)
      • KYC
      • Automatic KYC
      • Messente
      • Advanced Referral
      • CoinMarketCap
      • Guardarian
    • Install Plugins
    • Developing Plugins
      • Development Walkthrough: Hello-Plugin
        • Initialization
        • Configuration
        • Scripting
        • Web View
        • The Final Product & Installation
      • Advanced
        • Initialization
        • Config
        • Server Script
        • Plugin Libraries
        • Web View
        • Final Plugin Product
        • Advanced Tutorial: Using the user meta field
        • Advanced Tutorial: Adding a new database table column
        • Advanced Tutorial: Creating a new database table
      • Simple Wallet Example
      • Web View Development
        • Overview
        • External dependencies
        • Getting started
        • Basic Tutorial: Hello Exchange Plugin web view
        • Advanced Tutorial: KYC Plugin web views
    • Bank Integration
      • Handling Deposits
      • Handling Withdrawals
  • 👷Developers
    • API Guide
      • API Example Scripts
    • Run Dev Mode
    • Build a New Front-end Interface
  • 🧰On-Premise Operators (Advanced Only)
    • On-Premise Exchange Setup
      • Getting Started — Requirements
      • Installation
      • Server Setup
      • Web Setup
      • Production
    • CLI How-Tos
      • Start Exchange
      • Stop Exchange
      • Upgrade Exchange
        • Build and Apply the Code Changes
      • Get Exchange Logs
      • Get a Backup and Restore
      • Exchange Migration
      • Command List
    • Run Exchange on Kubernetes
    • Troubleshooting Guide
  • 🚀Advanced
    • SEO Optimization
    • Nginx
    • Rate Limits
    • Database
      • Upgrade Database
    • Dependencies
    • Contents Delivery Network
      • Cloudflare CDN for HollaEx
      • CloudFront CDN for HollaEx
    • Load Balancer
      • AWS ELB
      • DigitalOcean LB
    • Customize Kubenretes Ingress
    • Exchange Keys
      • Exchange API Keys Troubleshoot
    • HollaEx on non-Linux
      • HollaEx on Windows
      • HollaEx on macOS
    • The Network Tool Library
      • Accessing the Network Tool Library
      • Functions
        • WebSocket
      • Simple Example: Creating a User and Wallet
      • Getting More Interesting: Orders with the Tools
        • Setup: Using the transferAsset function
        • Creating and Monitoring a Sell Order
        • Settling Fees
      • Private HollaEx Network
    • Docker Content Trust (DCT)
    • Revenue Sharing
  • 📦Releases
    • Release Notes
    • Side Notes
  • ➡️External Links
  • Blogs
  • Forum
  • Videos
  • Twitter X
  • Telegram
  • Interactive Demo
  • Discord Community
  • API Documentation
  • Tools Library Documentation
  • Node Library Documentation
  • Plugins Documentation
Powered by GitBook
On this page
  • HollaEx Dashboard Account 🎛️
  • System Requirements 🖥️
  • Operating Systems ⚙️
  • Software Packages 🧩
  • Production Prerequisites 🌐
  1. On-Premise Operators (Advanced Only)
  2. On-Premise Exchange Setup

Getting Started — Requirements

PreviousOn-Premise Exchange SetupNextInstallation

Last updated 5 months ago

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 .

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).

To gain access to the HollaEx Dashboard, please submit the following form, and the HollaEx team will be in touch with the first steps.

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 to see more details. HollaEx is available both on and . 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.

  • Debian-based Linux (Ubuntu), RHEL (CentOS),

    • Or macOS with Bash shell (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.

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, but 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.

  • Your own domain

  • Your own Docker registry e.g. Docker Hub (Optional)

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 to learn the slightly different setup process.

Or or higher with Enabled (check the section below).

Or or higher with Enabled.

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 if this is what you will be using.

(Recommended for hosting)

for email service

for security

🧰
Windows 10 2004
WSL 2
Windows 10 2004
WSL 2
HollaEx on macOS
HollaEx on Windows
SMTP
Google reCaptcha Account
offered Cloud plans
HollaEx Blog
AWS Marketplace
DigitalOcean Marketplace
HollaEx Dashboard Account
System meeting minimum requirements
Compatible operating system, with steps taken to ready for HollaEx if required
Required packages installed
Production prerequisites, if intending to make the site live on the internet
these docs
next section
Amazon AWS