Operation

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

hollaex import

Import downloaded settings files from bitHolla Dashboard.

hollaex import --path <SETTINGS_FILE(S)_PATH>

This command is required to integrate your configured data from bitHolla Dashboard to your exchange. For information on how to start a new exchange, check here.

You can also use this command to import settings files with modified configurations from bitHolla Dashboard. If you change something for your exchange, you should re-import it to your HollaEx Kit by using this command. In this case, running hollaex restart is required to actually applying the configurations to the exchange. Check here for more details.

hollaex setup

Set up your exchange.

hollaex setup (--kube)

We recommend you import the settings files from the bitHolla dashb oard to your HollaEx Kit by using the hollaex import command above before running hollaex setup. If the files are not imported when hollaex setup has been executed, the CLI will bring up the command-line exchange configurator.

The --kube flag will setup the exchange at the Kubernetes cluster. Make sure to export your KUBECONFIG file before running this command.

hollaex start

Start your exchange.

hollaex start (--kube) (--skip)

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

The --kube flag will start the exchange at the Kubernetes cluster. Make sure to export your KUBECONFIG file before running this command.

hollaex stop

Stop your exchange.

hollaex stop (--kube)

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.

The --kube flag will stop the exchange at the Kubernetes cluster. Make sure to export your KUBECONFIG file before running this command.

hollaex restart

Restart your exchange.

hollaex restart (--kube)

This command will fully restart the exchange. Make sure this is your intent before running this command. hollaex restart can be for applying new configurations to your exchange or restarting your exchange in case there is an unexpected error.

The --kube flag will restart the exchange at the Kubernetes cluster. Make sure to export your KUBECONFIG file before running this command.

hollaex upgrade

Upgrade the existing exchange to the new HollaEx Core version.

hollaex upgrade (--version <VERSION_NUMBER>) (--kube)

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.

The CLI will build your own 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.

The --kube flag will upgrade the exchange at the Kubernetes cluster. Make sure to export your KUBECONFIG file before running this command.

hollaex status

View your exchange's status.

hollaex status (--kube)

This command will show the status of your exchange by listing the Docker containers and calling the exchange health API (/v1/health) with curl.

The --kube flag will bring up the status of your exchange at the Kubernetes cluster. Make sure to export your KUBECONFIG file before running this command.

hollaex logs

View your exchange's server logs.

hollaex logs (--target=<NAME_OF_COMPONENTS>) (--lines <LINES_OF_LOGS>) (--kube)

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

You can also specify the target container by running the command with target name. For example, hollaex logs --target api to see API container log only. I(t will only display last 10 lines of logs by default. Append --lines <LINES_OF_LOGS> to the command to log more lines.

The --kube flag will show the logs of your exchange at the Kubernetes cluster. Make sure to export your KUBECONFIG file before running this command.

hollaex terminate

Terminate your exchange from your system.

hollaex terminate (--kube)

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.

The --kube flag will terminate the exchange at the Kubernetes cluster. Make sure to export your KUBECONFIG file before running this command.

hollaex web (--flags)*

Operating the web client server for the exchange.

hollaex web (--setup / --start / --stop / --restart / --build / --terminate) (--kube)

You can build, setup, start, stop, and terminate the web client server for the exchange (web trading page) by using hollaex web command sets.

The web client server is based on /web folder in your HollaEx Kit. You can freely customize all codes and details in the /web folder. Make sure to run hollaex web --build to build a new Docker image to apply new code changes.

You can see the details here.

The --kube flag will do exactly same operation for web at the Kubernetes cluster. Make sure to export your KUBECONFIG file before running this command.

hollaex toolbox (--flags)*

Advanced features for system-level exchange operations.

hollaex toolbox (--kube)

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.

hollaex toolbox is a combination toolbox of advanced features which could be helpful to run the exchange. To see all toolbox commands, click here.

The --kube flag for toolbox fully depends on each different toolbox feature. Some of them might could not support Kubernetes operation. Please make sure the toolbox command you are going to use supports Kubernetes before you run something.