vaxtor/vaxtorgenesis repository overview

⁠Vaxtor GENESIS

This Docker image provides an easy, production-ready way to deploy and run Vaxtor’s generic reader (VaxtorGenesis) application. The application requires a valid license key for operation and offers multiple configurations to suit testing, production, and persistent data needs.

⁠Quick Start

To quickly test the application, use the following command. This command starts the container, applies the license specified in <productkey>, and exposes the application on port 8444.

docker run -it --rm -p 8444:8444 -e PRODUCT_KEY=<productkey> vaxtor/vaxtorgenesis

After running this command, the application will be accessible at https://<containerip>:8444.

Important: The above setup is intended for testing purposes only. Data, configuration, and license information will not persist once the container is stopped.

⁠Licensing Configuration

ℹ️ You can request a trial license at [email protected]⁠

💡 Note: If both the LICENSE_SERVER_ADDR and PRODUCT_KEY environment variables are set, the PRODUCT_KEY will be ignored, and the application will consume the license from the specified server.

⁠Persistent Licensing (Standalone)

To retain the license across container restarts, mount a persistent volume for the license as follows:

docker run -it --rm -p 8444:8444 -e PRODUCT_KEY=<productkey> -v vaxtorgenesis-lic:/var/hasplm vaxtor/vaxtorgenesis

This command stores the license in the vaxtorgenesis-lic volume, allowing it to persist even if the container is recreated.

⁠Using a License Server

If you prefer to use a license server instead of applying a local license, set the LICENSE_SERVER_ADDR environment variable with the IP address of your license server:

docker run -it --rm -p 8444:8444 -e LICENSE_SERVER_ADDR=192.168.0.88 vaxtor/vaxtorgenesis

This command will consume the license from the license server 192.168.0.88.

⁠Persistent Configuration

To retain the application’s configuration across container restarts, mount a persistent volume for the configuration as follows:

docker run -it --rm -p 8444:8444 -e PRODUCT_KEY=<productkey> -v vaxtorgenesis-config:/etc/vaxtorgenesis vaxtor/vaxtorgenesis

⁠Full Persistence (License and Configuration)

To ensure that both the license and configuration persist, use the following setup:

docker run -d -p 8444:8444 -e PRODUCT_KEY=<productkey> -v vaxtorgenesis-config:/etc/vaxtorgenesis-v vaxtorgenesis-lic:/var/hasplm --name vaxtorgenesis vaxtor/vaxtorgenesis

This command will:

1. Keep the container running as a named instance (vaxtorgenesis).
2. Persist both the license and configuration in the specified volumes.

⁠Start and Stop the Container

Once the container has been started with a persistent setup, it can be controlled as follows:

docker start vaxtorgenesis
docker stop vaxtorgenesis

⁠License Volume Sharing

The vaxtorgenesis-lic volume can be shared among multiple containers on the same host. However, only one container can actively use the license at a time. If you start a new container using the shared license volume while another container is running, the license will not function in the new container. To switch usage, stop the currently running container before starting a new one that uses the vaxtorgenesis-lic volume.