Basic

Before starting...

If you wish to run your exchange for production, we recommend you setup the following third-party services. These items are optional and if you wish to run the exchange locally, you don't require these.

Setup Methods

There are two ways to configure your exchange:

This basic setup tutorial will go over the bitHolla dashboard configuration process. For information on how to configure your exchange via HollaEx CLI, click here.

Exchange Configuration

The bitHolla Dashboard provides a visual and easy-to-follow way to configure an exchange. Go to the dashboard and create an account. Once you create an account, click the "Create Exchange" button.

There are 2 categories of setup available: Business Setup and Technical Setup.

Business Setup contains business related configurations, such as the exchange name, exchange logo, and digital assets available on the exchange. Technical Setup contains more tech-related configurations, such as the email server, domain address, and data storage setup. Both setups are required to run the full exchange. For more information on the individual configuration values, check out our advanced guide.

Once done, you'll be able to download two files: configmap and secret.

Exchange Server Initialization

You can now move on to initialize your exchange by using the command below.

You could also do the automated downloading part for exchange configurations manually if you want. Please check this page to see how. It is not recommended for most of users.

hollaex setup

The CLI will ask your credentials for bitHolla Dashboard to login. You will be able to select your exchange through CLI once it's done. The CLI will automatically download your exchange configurations that you finished through bitHolla Dashboard.

The CLI will immediately proceeds to build a custom HollaEx Core image based on your HollaEx Kit configuration. This custom image includes a /mail folder and /plugins folder in your HollaEx Kit. Both components can be customized based on your needs.

It is possible to set a custom name for the built image. We recommend you push the image to your docker registry as a backup for future usage and history.

Note: For Kubernetes deployment you require to host your image on a docker registry.

Once it's all done, Press Y again to bring up the docker containers and configurations.

The CLI then creates Docker containers for your exchange's server, currencies, and trading pairs that you configured at bitHolla Dashboard. This process typically takes few minutes so be patient!

Once the hollaex setup process is done, you will have to manually start the exchange server via hollaex start.

You can see the exchange status briefly by using hollaex status command once exchange is up.

Checking exchange

After starting your exchange, you can reach it through your web browser via the endpoints /v1/health and /v1/constant.

/v1/heatlh

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

/v1/constant

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

You can view the API documentation for the exchange here.

Bringing up the Exchange website

HollaEx Kit provides a web client server as an open source project for a HollaEx Kit exchange. It's included in the /web directory of your HollaEx Kit. The default client contains everything needed for your exchange but feel free to customize it based on your needs. Check here to see more about web customization.

hollaex web --start command will build the web client Docker image and bring it up online. Once up, you'll be able to reach it by using the domain that you configured earlier through the bitHolla Dashboard. If you are running it locally, go to http://localhost:8080 to reach it. Please check here to see more about hollaex web command sets.