Skip to content

Commit b2ae6fb

Browse files
author
mar
committed
doc: write about integrity check in tcm
1 parent ab2bf3f commit b2ae6fb

File tree

1 file changed

+5
-18
lines changed

1 file changed

+5
-18
lines changed

doc/tooling/tcm/tcm_integrity_check.rst

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Integrity check
77
:start-after: ee_note_tcm_start
88
:end-before: ee_note_tcm_end
99

10-
TCM supports the integrity check mechanism.
10+
|tcm| supports the integrity check mechanism.
1111
This feature ensures that the environment, application files, and centralized configuration have not been tampered with after packaging and publishing.
1212

1313
The integrity check mechanism is used to:
@@ -16,9 +16,6 @@ The integrity check mechanism is used to:
1616
* Prevent launching or running TCM in a compromised state.
1717
* Detect unauthorized changes in centralized configuration.
1818

19-
This feature is available for any application managed by tt, including TCM.
20-
21-
2219
.. _tcm_integrity_check_enable:
2320

2421
Enabling integrity check
@@ -54,11 +51,11 @@ Configuration parameters
5451
- Description
5552
- Type
5653
- Default
57-
* - ``security.integrity-check``
54+
* - :ref:```security.integrity-check`` <tcm_configuration_reference_security_integrity-check:`
5855
- Enables signature validation
5956
- ``bool``
6057
- ``false``
61-
* - ``security.signature-private-key-file``
58+
* - :ref:```security.signature-private-key-file`` <tcm_configuration_reference_security_signature-private-key-file:`
6259
- Path to the private key for signing configuration
6360
- ``string``
6461
- ``""``
@@ -81,8 +78,8 @@ Environment variables
8178
Example configuration
8279
=====================
8380

84-
Integrity check in TCM can be enabled and customized using several methods.
85-
You can configure it directly in the TCM configuration file or through environment variables when starting the application.
81+
Integrity check in |tcm| can be enabled and customized using several methods.
82+
You can configure it directly in the |tcm| configuration file or through environment variables when starting the application.
8683

8784
* In configuration file:
8885

@@ -102,13 +99,3 @@ You can configure it directly in the TCM configuration file or through environme
10299
export TCM_SECURITY_SIGNATURE_PRIVATE_KEY_FILE=/etc/tcm/private_key.pem
103100
104101
tt --integrity-check /etc/tcm/public_key.pem start tcm
105-
106-
107-
108-
109-
110-
111-
112-
113-
114-

0 commit comments

Comments
 (0)