You need to have docker installed. (https://www.docker.com/products/docker-desktop)
- To install and get the XLayer API running copy the following directories to your machine:
- api
- kafka
- mariadb \ sqlexpress
- xlayerapi
-
In each directory, check the docker-compose.yml file to make sure you are using the Windows paths under "volumes:" and that the paths are correct. Comment out the *nix volumes.
-
Now from each directory run the following
docker-compose up -d
(NOTE: if you run docker-compose up you will need to have an existing network in docker called xlayerapi. This network can be created by running 'docker network create -d bridge xlayerapi'):
- Alternatively you can run the LaunchXLayerAPI.cmd cmd file and select which containers you would like to start. If you use this method the network is created for you.
NOTE:
I had to make my my.cnf READ-ONLY
The FIRST time you run this the database needs to be created. For some reason this can take up to 7mins. Be patient. Look at the logs for that container using the following command:
docker logs xlayer-api-db01
Run this a few times until you see the following:
xlayer-api-db01 | xxxx-xx-xx xx:xx:xx 0 [Note] mysqld: ready for connections.
xlayer-api-db01 | Version: '10.4.11-MariaDB-1:10.4.11+maria~bionic' socket: '/var/run/mysqld/mysqld.sock' port: 3306 mariadb.org binary distribution
You should then be able to connect to the MariaDB using an external tool like DBeaver. (localhost:3306)
**** IF YOU SEE THIS: ****
xlayer-api-db01 | xxxx-xx-xx xx:xx:xx [Note] [Entrypoint]: Temporary server started.
You need to wait for the database to be initialized completely.
Useful URLS:
SWAGGER Documentation = https://localhost:9788/swagger-ui.html
Spring Management = https://localhost:9789/actuator
= https://localhost:9789/actuator/health
TODO:
- Add XLayerAPI SpringBoot app to an Image that can be run from docker.
- Create Image with relevant mysql database installed and upload to XLayer docker repo.
- Check why the swagger documentation (ApiModelProperty for the TransactionResponse is not being displayed correctly.
ADDITIONAL NOTES:
Adding a self-signed certificate was done by following this tutorial: https://www.thomasvitale.com/https-spring-boot-ssl-certificate/ This app's Keystore is a PKCS12 keystore and is kept in the "sxirestapi.p12" file (Keystore Password = sXi_Pass) NOTE: You will need to import the certificate (sxirestapiCert.crt) into any app wanting to communicate with xlayer-api (password = sXi_Pass)
Running as a windows service:
WinSW - https://github.com/kohsuke/winsw