Skip to content

Commit 5da235a

Browse files
security: improve settings docs (#23272)
## Description Product request to improve settings docs w/ information about grouped settings, and viewing settings hidden from the DD GUI ## Related issues or tickets https://docker.atlassian.net/browse/ENGDOCS-2925 ## Reviews - [ ] Editorial review
1 parent aa15629 commit 5da235a

File tree

4 files changed

+59
-2
lines changed

4 files changed

+59
-2
lines changed

content/manuals/enterprise/security/hardened-desktop/settings-management/_index.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,24 @@ When settings are enforced:
8383

8484
This ensures consistent environments while maintaining a clear visual indication of which settings are managed by administrators.
8585

86+
## View applied settings
87+
88+
When administrators apply Settings Management policies, Docker Desktop greys out most enforced settings in the GUI.
89+
90+
The Docker Desktop GUI doesn't currently display all centralized settings,
91+
particularly Enhanced Container Isolation (ECI) settings that administrators
92+
apply via the Admin Console.
93+
94+
As a workaround, you can check the `settings-store.json` file to view all
95+
applied settings:
96+
97+
- Mac: `~/Library/Application Support/Docker/settings-store.json`
98+
- Windows: `%APPDATA%\Docker\settings-store.json`
99+
- Linux: `~/.docker/desktop/settings-store.json`
100+
101+
The `settings-store.json` file contains all settings, including those that
102+
may not appear in the Docker Desktop GUI.
103+
86104
## Limitations
87105

88106
Settings Management has the following limitations:

content/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,16 @@ For existing installations:
8181
8282
Docker Desktop checks for policy updates when it launches and every 60 minutes while running.
8383

84+
## Verify applied settings
85+
86+
After you apply policies:
87+
88+
- Docker Desktop displays most settings as greyed out
89+
- Some settings, particularly Enhanced Container Isolation configurations,
90+
may not appear in the GUI
91+
- You can verify all applied settings by checking the [`settings-store.json`
92+
file](/manuals/desktop/settings-and-maintenance/settings.md) on your system
93+
8494
## Manage existing policies
8595

8696
From the **Desktop Settings Management** page in the Admin Console, use the **Actions** menu to:

content/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,36 @@ Settings where `locked` is set to `false` are ignored on existing installs if
6262
a user has already customized that value in `settings-store.json`,
6363
`settings.json`, or `daemon.json`.
6464

65-
### Example configuration
65+
### Grouped settings
66+
67+
Docker Desktop groups some settings together with a single toggle that controls
68+
the entire section. These include:
69+
70+
- Enhanced Container Isolation (ECI): Uses a main toggle (`enhancedContainerIsolation`) that enables/disables the entire feature, with sub-settings for specific configurations
71+
- Kubernetes: Uses a main toggle (`kubernetes.enabled`) with sub-settings for cluster configuration
72+
- Docker Scout: Groups settings under the `scout` object
73+
74+
When configuring grouped settings:
75+
76+
1. Set the main toggle to enable the feature
77+
1. Configure sub-settings within that group
78+
1. When you lock the main toggle, users cannot modify any settings in that group
79+
80+
Example for `enhancedContainerIsolation`:
81+
82+
```json
83+
"enhancedContainerIsolation": {
84+
"locked": true, // This locks the entire ECI section
85+
"value": true, // This enables ECI
86+
"dockerSocketMount": { // These are sub-settings
87+
"imageList": {
88+
"images": ["docker.io/testcontainers/ryuk:*"]
89+
}
90+
}
91+
}
92+
```
93+
94+
### Example `admin-settings.json` file
6695

6796
The following sample is an `admin-settings.json` file with common enterprise settings configured. You can use this example as a template with the [`admin-settings.json` configurations](#admin-settingsjson-configurations):
6897

content/manuals/enterprise/security/hardened-desktop/settings-management/settings-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ host directories into containers.
265265
usage statistics and crash reports to Docker. This setting affects telemetry
266266
gathered from the Docker Desktop application itself. It does not affect
267267
server-side telemetry collected via Docker Hub or other backend services, such
268-
as login timestamps, pulls, or builds.
268+
as sign in timestamps, pulls, or builds.
269269
- **OS:** {{< badge color=blue text="All" >}}
270270
- **Use case:** Help Docker improve the product based on usage patterns.
271271
- **Configure this setting with:**

0 commit comments

Comments
 (0)