This documentation provides instructions for deploying and managing the Liminal Express API using Docker containers. Follow these steps to install, check the TSM version, stop/delete the container, update the image, and start the Docker container with your configurations.
Check MPC Version (TSM-Version)
Use the following command to check the TSM Version (TSM-Version):
curl http://localhost:8000/version
The response from this command will provide the TSM Version, which you will need for the next step.
Stopping and Deleting the Liminal SDK API Container
To stop and delete the Docker container, run the following command, replacing container_id with the actual container ID:
docker stop container_id && docker rm container_id
Note: Do not delete the MPC Server Image.
Pulling the Latest Image
To pull the latest Docker image, use the following command:
docker pull 641754881946.dkr.ecr.us-west-2.amazonaws.com/liminal-sdk-api:latest_version_provided
eg: docker pull 641754881946.dkr.ecr.us-west-2.amazonaws.com/liminal-sdk-api:1.1.0
You can view all available versions on Liminal Express API changelog.
Starting the Docker Container
Start the Docker container with the following command, replacing the placeholders with your specific configuration details:
docker run --restart=on-failure -e AWS_DEFAULT_REGION=YOUR_AWS_DEFAULT_REGION
-e REGION=YOUR_AWS_DEFAULT_REGION
-e NODE_ENV=prod
-e TSM_URL=YOUR_TSM_URL
-e TSM_VERSION=YOUR_MPC_VERSION
-e TSM_USER_ID=YOUR_TSM_USER_ID
-e TSM_PASSWORD=YOUR_TSM_PASSWORD
-e TSM_PUBLIC_KEY=YOUR_TSM_PUBLIC_KEY
-p 8081:8081 -d 641754881946.dkr.ecr.us-west-2.amazonaws.com/liminal-sdk-api:<image_tag>
Ensure that you replace the placeholders with your specific configuration details:
YOUR_AWS_DEFAULT_REGION: Replace with your AWS default region.
YOUR_TSM_VERSION: Replace with your TSM version obtained from Step 2.
YOUR_TSM_URL: Replace with the URL of your TSM.
YOUR_TSM_USER_ID: Replace with your TSM user ID.
YOUR_TSM_PASSWORD: Replace with your TSM password.
YOUR_TSM_PUBLIC_KEY: Replace with your TSM public key.
Run Info Curl
Once the Express Docker is deployed in the client infrastructure then run the following CURL.
curl http://localhost:8081/info
It will give the response of the express version, and we will ensure that the docker is running properly.