docker-xterm

If you are beginning your journey with Senzing, please start with Senzing Quick Start guides.

You are in the Senzing Garage where projects are "tinkered" on. Although this GitHub repository may help you understand an approach to using Senzing, it's not considered to be "production ready" and is not considered to be part of the Senzing product. Heck, it may not even be appropriate for your application of Senzing!

Synopsis

A docker container that gives a web-based terminal. Similar to ssh, but over HTTP/S.

Overview

The senzing/xterm container is a web application that creates the facade of a Xterm window. Behind the scenes, keystrokes typed into the web-based Xterm window are sent via socket to the running docker container to be executed within the container. The results of the command are sent via socket back to the web Xterm window.

Senzing commands such as G2Command.py, G2Explorer.py, etc. can be executed in Xterm.

To access files outside of the container, files should be place on volumes mounted to docker container.

Contents

1. Expectations
2. Use
3. References
4. License

Expectations

• Space: This repository and demonstration require 6 GB free disk space.
• Time: Budget 20 minutes to get the demonstration up-and-running, depending on CPU and network speeds.
• Background knowledge: This repository assumes a working knowledge of:
  • Docker

Use

Prerequisites

1. docker

Run Docker container

1. ✏️ Identify a port to view XTerm. Example:

   export SENZING_XTERM_PORT=8254

2. Run Docker container. Example:

   sudo docker run \
     --rm \
     --publish ${SENZING_XTERM_PORT}:5000 \
     senzing/xterm

View XTerm

The web-based Senzing X-term can be used to run Senzing command-line programs.

1. If SENZING_XTERM_PORT was set to 8254, Senzing X-term will be viewable at localhost:8254.

2. In general, visit the web address having the following format: http://${SENZING_XTERM_HOST}:${SENZING_XTERM_PORT} Example:

   export SENZING_XTERM_HOST=localhost
   export SENZING_XTERM_PORT=8254

   becomes http://localhost:8254.

3. See additional tips for working with Senzing X-Term.

License

View license information for the software container in this Docker image. Note that this license does not permit further distribution.

This Docker image may also contain software from the Senzing GitHub community under the Apache License 2.0.

Further, as with all Docker images, this likely also contains other software which may be under other licenses (such as Bash, etc. from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.

References

• Development
• Errors
• Examples
• Related artifacts
  • DockerHub
  • Helm Chart