Operation

You need to setup the exchange completely before running the commands below. If you haven't, Please check Get Started, Installation, and Setup sections.

You should always be on HollaEx Kit directory to run any hollaex commands.

This section only lists the core commands required for exchange operations. Full command list is available in here.

hollaex start

Start your exchange.

hollaex start

This command is an "on" switch for your exchange. You should run this command after hollaex setup to start the exchange and get it online. This command also applies the latest changes to the settings directory.

To see the full command list for hollaex start, Check here for more details.

hollaex stop

Stop your exchange.

hollaex stop

This command is an "off" switch for the exchange. It doesn't remove anything from the system. You can start your exchange anytime with the hollaex start command described above.

To see the full command list for hollaex stop, Check here for more details.

hollaex restart

Restart your exchange.

hollaex restart

This command will fully restart the exchange. This command can be used for applying new configurations to your exchange or restarting your exchange if something unexpected happens.

To see the full command list for hollaex restart, check here for more details.

hollaex build

(Re)build the custom HollaEx Core image based on your changes in the Kit.

hollaex build

This command will build the user HollaEx Core image with user's HollaEx Kit data. If you make code changes on /mail for example, You should rebuild the image by running this command.

After the build, You should run hollaex restart to restart the exchange completely to apply the new image to the current server. This command is necessary for custom updates and changes.

hollaex upgrade

Upgrade the existing exchange to the new HollaEx Core version.

hollaex upgrade --version <VERSION_NUMBER_OF_HOLLAEX_CORE>

This command will upgrade your exchange to a new HollaEx Core version. Make sure to specify the correct version number of HollaEx Core by using the --version flag. You can always see the latest HollaEx Core version at here.

During the upgrade procedure, The CLI will build a custom HollaEx Core image similar to the initial hollaex setup command. This build includes your /mail folder and /plugins folder. If you made any changes to your /mail or /plugins directories, use this command to apply the changes.

To see the full command list for hollaex upgrade, Check here for more details.

hollaex status

View your exchange's status.

hollaex status

This command shows the current status of your exchange by listing different containers and calling the exchange domain.

To see the full command list for hollaex status, Check here for more details.

hollaex logs

View your exchange's server logs.

hollaex logs

This command will show the logs of each Docker container for the exchange.

To see the full command list for hollaex logs, Check here for more details.

hollaex terminate

Terminate your exchange from your system.

hollaex terminate

This command terminates the whole exchange from your system. We recommend you make a full database backup by using hollaex toolbox --backup command.

This command will terminate the entire exchange on your system. The exchange service will become immediately unavailable. This operation cannot be reversed so think twice before running this command.

To see the full command list for hollaex terminate, Check here for more details.

hollaex web (--flags)*

Operating the web client server for the exchange is possible with hollaex web command sets.

You could setup the web server initially with the command below.

hollaex web --setup

The web client server is based on /web folder in your HollaEx Kit. You can freely customize all code and details in the /web folder. hollaex web --setup would build a custom web server Docker image with code in user's Kit, /web folder.

You should start the web server with the command below once the setup procedure are all done.

hollaex web --start

Stopping the started web server can be done with the command below. You could also start the stopped web server with the command above later.

hollaex web --stop

If you want to restart the web server due to some reason, or if you want to apply new code on web, run the command below. The restart command contains a Docker image rebuild option. Make sure to rebuild the image if you want to apply new code changes.

hollaex web --restart

You could also only build the web Docker image separately with the command below, without affecting the existing web server running.

hollaex web --build

For the full command list for hollaex web, Check here for more details.

hollaex toolbox (--flags)* (Advanced)

hollaex toolbox is a combination toolbox of advanced features which could be helpful to run the exchange. On this section, there are only few of handpicked toolbox commands are listed.

For the full command list for hollaex toolbox, Check here for more details.

Features of toolbox will be continuously added on new releases. You'll be always able to see full commands and flags by typing just hollaex on your terminal.

Adding new custom currencies and trading pairs

You could add custom currencies (coins) on your exchange with the command below

hollaex toolbox --add_coin

You could add custom trading pairs on your exchange with the command below

hollaex toolbox --add_trading_pair

Making a database backup

You can run a full database backup for your exchange with the command below.

hollaex toolbox --backup

Issuing a SSL cert

You can issue the SSL certificate with Let's Encrypt for both of your exchange API server and exchange web server with the command below.

hollaex toolbox --issue_ssl

Renewing the existing SSL certificate is also possible through the command below.

hollaex toolbox --renew_ssl