Deployment
The Topic Registry is distributed as a Docker image, making it easy to deploy on any system that supports Docker. Follow these steps to deploy the solution and configure it to work with Litmus Edge.
- Litmus Edge IP Address or Hostname The IP address or hostname of the Litmus Edge instance to connect to.
- Litmus Edge REST API Token A valid REST API token generated from the Litmus Edge instance. Refer to the Litmus Edge documentation for instructions on generating an API token.
- Litmus Edge API Account Token A valid API account token for connecting to the Litmus Edge Message Broker. This token authenticates the Topic Registry to receive real-time updates. See the Litmus Edge documentation for details on generating an API account token.
- Note: Ensure the NATS Proxy is enabled and that the account token has permission to subscribe to all topics by including > in the Read Topics configuration.
- Docker Docker must be installed on the machine where the Topic Registry will be deployed. For installation instructions, refer to the Docker documentation.
The docker image is available on Litmus Central. Download the appropriate version and load the image into your Docker environment using the following command:
To deploy the solution without configuring environment variables in advance, run the following command. This will expose the solution on port 3000:
If you are deploying the image in Litmus Edge, please add the option --network host to the above command.
You can pre-configure the solution using environment variables:
- EDGE_HOSTNAME: The IP address or hostname of the Litmus Edge instance.
- EDGE_NATS_TOKEN: The API account token for connecting to the Litmus Edge Message Broker.
- EDGE_API_TOKEN: The API token for accessing Litmus Edge API endpoints.
- NEXT_PUBLIC_X_LITMUS_KEY: A secret key for authenticating REST API requests.
- NEXT_PUBLIC_SHOW_LOGGER: Set to true to enable verbose logging for debugging.
Note You can provide these environment variables during deployment or configure them later via the solution's web UI.
For a pre-configured deployment, include the necessary environment variables in the Docker run command as follows:
Replace <edge-hostname>, <edge-nats-token>, <edge-api-token>, and <solution-api-key> with your appropriate values.
Once the container is running, access the solution in your web browser at http://localhost:3000 or use the IP address of the host machine.