Server Setup

This is the main part of On-Premise exchange setup process, where we setup the exchange and get it ready for launch

Before you start with the exchange setup, make sure you have registered on HollaEx Dashboard and have created an exchange project.

In addition, the HollaEx Kit folder and CLI must be installed on your machine. Please check the Installation section if you haven't already done so.

Exchange Server Initialization

If you are looking for a way to deploy HollaEx on Kubernetes, Please check out the Kubernetes docs available here.

Initialize the exchange setup by running the command below:

hollaex server --setup

The CLI will print some information and then ask for the HollaEx Network selection.

  • The Mainnet HollaEx Network is very likely the choice you will want to make for an operating exchange and to benefit from the shared liquidity of the HollaEx Network.

  • The Testnet HollaEx Network allows, unsurprisingly, a testing environment, ideal for developers who are developing plugins.

  • Lastly, if you have a private HollaEx Network, you need to select the Custom HollaEx Network option.

Select the choice relevant to you, and press the enter key to continue.

Once the network is selected, in the case you are connecting to the Mainnet HollaEx Network, the next step is to link your Dashboard account.

Input Y and enter the email and password used in your setup, as well as the OTP code if you have set this up already.

If you don't have an account, input N, and the Dashboard should open up for you, follow the instructions here, come back to the terminal once complete, and then enter your details.

On successful login, a verification code will be sent to the email, copy and paste this over and hit enter.

The HollaEx CLI will then begin to finalize the exchange initialization if all the values are valid.

If you get an 'Error: Exchange owner is not verified yet! 'at this step, head back to the dashboard and be sure to complete the verification steps to continue

The CLI then immediately proceeds to build a custom Docker image based on your HollaEx Kit configuration and code. A few questions will be asked during setup so keep an eye on the setup to answer these:

  1. First, if you want to change the image name. Type in the new name or just hit enter to continue.

  2. Confirmation on the name, again hit enter if you are happy.

  3. Finally, if you want to push an image to the Docker Registry. This is optional.

Let it run from this point, and once this initial setup is complete, you will be greeted with a large power symbol, and you can continue.

Now manually start the server. Run the command below to start the exchange - this will be far quicker than the previous step.

hollaex server --start

Checking Your Progress

At this point, it may give some peace of mind to check the progress of the setup, the steps below are not required to finish setup but are a good way to check how the process has gone.

Wait a minute or two after the previous command completes, and then run the command:

hollaex status

Which should return the green text as in the image below. If it doesn't wait a few minutes, try again, as occasionally the setup takes a little time to finalize.

At this point, you should also be able to reach the exchange through your web browser via the endpoints /v2/health and /v2/constant:

This API displays your exchange's name, HollaEx version number, host URL, and base URL.

This API shows the list of currencies and trading pairs that you have on your exchange. You will be able to see all currencies and trading pairs you selected. If you don't see a list of your currencies or trading pairs, restart the exchange by running the command hollaex server --restart. If that doesn't solve the issue, you can always bring it up to the forum.

You can view the API documentation for HollaEx here and fork the API Docs and make your own.

Moving on up!

With everything in order let's move on to the web setup!

Last updated