Terminals installation

AWS Blu Insights Terminals runs on the customer environment. This guide focuses on how to run the Terminals jar, but it can also be launched with Docker.

Prerequisites

• Java 17 needs to be installed.

Step-by-step guide

1. Download Terminals last version archive from Blu Age Toolbox Tool
2. Unpack the file
3. Move to the unzipped file folder.

Run with Jar

1. Run the jar from the archive folder: java -Dsecure.token=<random_token> -jar terminals-....jar
   1. token is a random text set by you. It will be used to secure requests. Example: -Dsecure.token=test .You can also set it as an environment variable: export SECURE_TOKEN=<token>
   2. The default port for the application is 8080. You can update it using -Dserver.port=<port>
2. The application will by default run on localhost:8080. If port was updated, then localhost:<port>

Run with Docker

1. Create a Dockerfile with:

   FROM amazoncorretto:17-alpine 
   COPY terminals-*.jar terminals.jar 
   CMD ["java", "-Dserver.port=80", "-jar", "/terminals.jar"]

2. Build the Docker image: docker build -t terminals .
3. Run the docker container: docker run -p 80:80 -e SECURE_TOKEN=<random_token> terminals
4. The application will run on localhost:80

Logging

The logs of the Terminals application are the CloudWatch logs of the ECS task that run it. We log by default messages of socket creation and termination, and data exchange. For more detailed logs, you can add an environment variable to the docker container named JAVA_NET_LOG_OPT.           
It points to a java option javax.net.debug=, and it takes values like all and ssl. For more information about debugging, you can visit ReadDebug and DebugBlog.