Test Image

The test image is provided for testing and development purposes. It does not offer to run the NetHSM process with hardware-based separation (KVM), to encrypt the data store, or to use an external etcd. The connection between the NetHSM process and the integrated key-value store is unencrypted. The image is distributed as OCI image and can be run locally with a compatible executor such as Docker and Podman.

Compared to the NetHSM hardware the following functions are not implemented at software container’s REST API:

  • Network configuration

  • Factory reset

  • Reboot

  • Software update

The image can be obtained from Docker Hub.

Warning

Do not use the test image under any circumstances for production data and use cases. For production environments with high security demands you must use the production image.

Tagging Policy

The images in the repository are tagged with the Git commit hash from the main branch of the repository. The latest image is tagged with testing.

Configuration

The image can be configured with the following environment variables.

Environment variable

Description

DEBUG_LOG

Enables extended logging for NetHSM.

Usage

The container can be executed as follows.

$ docker run --rm -ti -p 8443:8443 docker.io/nitrokey/nethsm:testing

This will run NetHSM as a Unix process inside the container and expose the REST API via the HTTPS protocol on port 8443.

Important

The container uses a self-signed TLS certificate. Make sure to use the correct connection settings to establish a connection. Please refer to chapter NetHSM introduction to learn more.