Skip to content

Commit

Permalink
Clearify differences between images and include security recommendation
Browse files Browse the repository at this point in the history
  • Loading branch information
mmerklinger committed Oct 11, 2024
1 parent 28023cf commit 59c744f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
5 changes: 4 additions & 1 deletion nethsm/container/production-image.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
Production Image
----------------

The NetHSM production container is a product for paying customers only and can be purchased `here <https://www.nitrokey.com/contact>`__.
The production image is provided for production envrionments with high security demands.
It requires an external etcd key-value store and offers to run the NetHSM process with hardware-based separation.
The connection between the NetHSM process and the key-value store is encrypted.

The NetHSM production container is a product for paying customers only and can be purchased `here <https://www.nitrokey.com/contact>`__.
The image can be obtained from `Nitrokey NetHSM registry <https://registry.git.nitrokey.com/distribution/nethsm>`_ using the credentials provided after purchase.

.. warning::
Expand Down
5 changes: 5 additions & 0 deletions nethsm/container/test-image.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
Test Image
----------

The test image is provided for testing and development purposes.
It includes an integrated etcd key-value store, but does not offer to run the NetHSM process with hardware-based separation.
The connection between the NetHSM process and the key-value store is unencrypted.

The image can be obtained from `Docker Hub <https://hub.docker.com/r/nitrokey/nethsm>`_.

.. 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
^^^^^^^^^^^^^^
Expand Down

0 comments on commit 59c744f

Please sign in to comment.