Step 1: Running Axual

Running Axual locally

By following the steps below you can run Axual locally and follow the remainder of the Getting Started.


Before starting, there are a few things required to setup:

  • use any Linux distribution or OS X with Bash 4.2+ installed ( Windows systems are not supported )

  • install Docker, currently due to issues with the latest stable Docker release, the latest supported version supported is ( MacOS, Linux )

Make sure that your docker daemon has at least 3GB of RAM and 6 CPU cores

Downloading Axual

  1. login into Axual’s docker repository with docker login using the credentials provided by Axual.

  2. download the local installation of Axual using the same docker credentials.

Package contents

The example setup of Axual Deploy contains the following:

  1. Deployment scripts (scripts that start/stop the platform services)

  2. Platform configuration (cluster, instance and tenant configuration)

  3. Security folder with dummy Keystores for components in order to enable SSL communication

  4. The script

  5. The script

Initial setup (first time only)

The following steps are only necessary the first time. After you have completed these steps, your machine is setup and prepared to run Axual multiple times

Firstly, start your terminal application. Use your favorite text editor to append the following line at the bottom of your /etc/hosts file: " platform.local". platform.local

Next, we will unzip the previously downloaded tar file in a newly made directory.

mkdir ~/local-axual-directory
tar -xvf ~/Downloads/axual-platform-local-2020-2.tar.gz -C ~/local-axual-directory

Before running Axual for the first time, it is required to run the script to prepare your machine. You will be prompted for the sudo password for make a local modification to your hosts file.

You will also be prompted to create a password for a local (Dockerized) database. Please use the same password for all questions.
~/local-axual-directory/ -run

You should see the following output (or similar):

Writing the host file at /Users/[YOUR HOST]/
Creating local data directory at /Users/[YOUR HOST]/axual_local_data
The SQL file which contains demo statements already exists at /Users/[YOUR HOST]/.../initial-data.sql. Skipping creation...
The realm.json file which contains demo statements for Keycloak already exists at /Users/[YOUR HOST]/.../local-config/clusters/local/configuration/keycloak/realm.json. Skipping creation...

Starting an unsealed and configured Vault container.
Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
docker: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?.
See 'docker run --help'.
Local Vault started

URL        : http://localhost:8200
root token : [TOKEN]
Key 1      : [KEY}

Remember: This container is used for the local test installation, need to be stop and remove with docker commands
docker stop mgmt-local-vault && docker rm -f mgmt-vault-local
Setup complete.

Start the platform with './ [-v] start' (optional argument '-v' stands for verbose)
You will be prompted to insert the DB root password.

After the platform starts, login into the self-service portal using the following credentials:
Username: ''
Password: 'password'

Use the following configuration for your application to connect to this Axual platform deployment:
Discovery Endpoint =
Tenant = demo
Environment =localenv
The key principal to be used in self service application registration and keystores can be found at /Users/sunny/development/local-config/security/application/
Truststores in PKCS12, JKS and PEM format can be found at /Users/.../local-config/security/application/common-truststore
All keystore, truststore and key passwords are 'notsecret'
The application ID and version are chosen by the developer and registered via self service

You can run './ -run' again to display this screen

In case your UI is not showing anything, check the console error of browser. There should be an error like:
CSP invalid.
In this case, copy the SHA value from the console and add it to /clusters/local/
inside MGMT_UI_SMALLCHAT_SHA variable.

Customization is possible, run the script with -help instead of -run for more information.

Trusting our Certificate Authority

In the local setup of the platform, we use a lot of certificates signed by "Axual Dummy Intermediate 01". In order to prevent browser warnings, you have to import that certificate in your local keychain (MacBook) and mark it as trusted.

  1. Download the Axual Dummy Intermediate 2018 01 certificate file

  2. Double click it, "KeyChain Access" will open.

  3. Mark the certificate as "Always Trusted" as indicated in the screenshot below

    Trusting Axual Dummy Intermediate 01

Running the platform

To simply start the platform, run the following command:

~/local-axual-directory/ start

If everything went successfully, a similar output should be present in the console:

Configuring cluster services for node localhost in cluster LOCAL
Preparing exhibitor: Done
Starting exhibitor: Done
Waiting for exhibitor on
Connected to exhibitor on
Preparing broker: Done
Starting broker: Done
Waiting for broker on
Connected to broker on
Preparing cluster-api: Done
Starting cluster-api: Done
Preparing distributor: Done
Starting distributor: Done
Deploying topic _company-local-environments: Done
Deploying topic _company-local-schemas: Done
Configuring instance services for company-local in cluster LOCAL
Stopping distributors with prefix company-local-message-distributor-from-: Done
Stopping distributors with prefix company-local-offset-distributor-from-: Done
Stopping distributors with prefix company-local-schema-distributor-: Done
Preparing company-local-sr-master: Done
Starting company-local-sr-master: Done
Preparing company-local-sr-slave: Done
Starting company-local-sr-slave: Done
Running copy-config-company-local-discovery-api: Done
Preparing company-local-discovery-api: Done
Starting company-local-discovery-api: Done
Preparing company-local-instance-api: Done
Cluster servers are https://platform.local:9080
Starting company-local-instance-api: Done
Configuring mgmt services for node localhost in cluster LOCAL
Running clean-config-prometheus: /config/prometheus
Generating prometheus targets...
Generating prometheus configuration...
Running create-config-prometheus: Done
Running copy-config-prometheus: Done
Starting prometheus: Done
Provisioning grafana dashboards...
Running copy-config-grafana: Done

After the platform starts, login into the self-service portal using the following credentials:

Please make sure to use a supported browser
Username: ''
Password: 'password'

To stop the platform, run the following command:

~/local-axual-directory/ stop

Next step: Creating A Stream

You are now ready to move on to the next step 2. Creating a stream to make sure you can connect to the platform securely and your application(s) can be authorized to access the stream.