Skip to content

Commit 532e5a3

Browse files
feat: add registry classification banner documentation
1 parent ba79a38 commit 532e5a3

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

src/content/docs/registry/configuration.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,29 @@ When `haDatabase` is enabled:
9898
|-----------|---------|---------|-------------|
9999
| `registry.logging.level` | `INFO` | `DEBUG`, `INFO`, `WARN`, `ERROR` | Log level |
100100

101+
### Classification Banner
102+
103+
Use the classification banner to render a header and footer in the UI. The `classification` value sets the banner colors and, if no label is provided, the banner text. If you provide a `label`, it replaces the displayed text, so you _must_ include the classification in the label if you want it shown (for example: `CUI//EXERCISE USE ONLY`). Providing only `classification: CUI` and `label: EXERCISE USE ONLY` displays only `EXERCISE USE ONLY`.
104+
105+
| Parameter | Default | Options | Description |
106+
|-----------|---------|---------|-------------|
107+
| `registry.classificationBanner.classification` | `""` | `UNCLASSIFIED`, `CUI`, `CONFIDENTIAL`, `SECRET`, `TOP SECRET`, `TOP SECRET//SCI` | Required classification value used to set banner colors. |
108+
| `registry.classificationBanner.label` | `""` | - | Optional label that overrides the displayed classification text. |
109+
110+
**Example**
111+
112+
```yaml
113+
classificationBanner:
114+
classification: "CUI"
115+
label: "CUI//EXERCISE USE ONLY"
116+
```
117+
118+
```yaml
119+
classificationBanner:
120+
classification: "SECRET"
121+
label: ""
122+
```
123+
101124
### Authentication Configuration <small>[(example)](#authentication-and-session-configuration)</small>
102125
103126
| Parameter | Default | Description |

0 commit comments

Comments
 (0)