Skip to content

Commit 4d3913f

Browse files
authored
SM: settings reference tidy (#23412)
<!--Delete sections as needed --> ## Description Updates the DD settings reference page ## Related issues or tickets <!-- Related issues, pull requests, or Jira tickets --> ## Reviews <!-- Notes for reviewers here --> <!-- List applicable reviews (optionally @tag reviewers) --> - [ ] Technical review - [ ] Editorial review - [ ] Product review
1 parent a0142e9 commit 4d3913f

File tree

1 file changed

+111
-62
lines changed

1 file changed

+111
-62
lines changed

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

Lines changed: 111 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,15 @@ aliases:
77
- /security/for-admins/hardened-desktop/settings-management/settings-reference/
88
---
99

10-
This reference documents all Docker Desktop settings and configuration options. Use this to understand setting behavior across different configuration methods and platforms.
10+
This reference documents all Docker Desktop settings and configuration options. Use this to understand setting behavior across different configuration methods and platforms. It is organized to match the Docker Desktop GUI structure.
1111

1212
Each setting includes:
1313

1414
- Default and accepted values
1515
- Platform compatibility
16-
- Configuration methods (Docker Desktop GUI, Admin Console, admin-settings.json file, or CLI)
16+
- Configuration methods (Docker Desktop GUI, Admin Console, `admin-settings.json` file, or CLI)
1717
- Enterprise security recommendations where applicable
1818

19-
## How to use this reference
20-
21-
Settings are organized to match the Docker Desktop GUI structure. Configuration
22-
methods are indicated with these labels:
23-
24-
- Desktop GUI: Configurable through Docker Desktop settings interface
25-
- Admin Console: Configurable through the Docker Admin Console using Settings Management
26-
- JSON file: Configurable through `admin-settings.json` using Settings Management
27-
- CLI: Configurable through command-line tools
28-
2919
## General settings
3020

3121
### Start Docker Desktop when you sign in to your computer
@@ -365,20 +355,6 @@ if needed.
365355
- **General** settings in [Docker Desktop GUI](/manuals/desktop/settings-and-maintenance/settings.md)
366356
- Settings Management: `configurationFileVersion` setting in the [`admin-settings.json` file](/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md)
367357

368-
### Automatically update components
369-
370-
| Default value | Accepted values | Format |
371-
|---------------|-----------------|----------|
372-
| `true` | `true`, `false` | Boolean |
373-
374-
- **Description:** Allow Docker Desktop to automatically update components that don't require a restart.
375-
- **OS:** {{< badge color=blue text="All" >}}
376-
- **Use case:** Automatically updates key Docker Desktop components such as Docker Compose, Docker Scout, the Docker CLI.
377-
- **Configure this setting with:**
378-
- **General settings** in [Docker Desktop GUI](/manuals/desktop/settings-and-maintenance/settings.md#software-updates)
379-
- Settings Management: `silentModulesUpdate` setting in the [`admin-settings.json` file](/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md)
380-
- Settings Management: **Automatically update components** setting in the [Admin Console](/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md)
381-
382358
## Resources settings
383359

384360
### CPU limit
@@ -484,6 +460,7 @@ edits.
484460
- **Configure this setting with:**
485461
- **Proxies** Resources settings in [Docker Desktop GUI](/manuals/desktop/settings-and-maintenance/settings.md)
486462
- Settings Management: `proxy` setting with `manual` and `exclude` modes in the [`admin-settings.json` file](/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md)
463+
- Settings Management: **Proxy** section in the [Admin Console](/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md)
487464

488465
> [!NOTE]
489466
>
@@ -539,6 +516,7 @@ edits.
539516
- **Configure this setting with:**
540517
- **Network** Resources settings in [Docker Desktop GUI](/manuals/desktop/settings-and-maintenance/settings.md)
541518
- Settings Management: `defaultNetworkingMode` setting in the [`admin-settings.json` file](/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md)
519+
- Settings Management: **Default network IP mode** in the [Admin Console](/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md)
542520

543521
For more information, see [Networking](/manuals/desktop/features/networking.md#networking-mode-and-dns-behaviour-for-mac-and-windows).
544522

@@ -555,6 +533,7 @@ version 4.43 and up.
555533
- **Configure this setting with:**
556534
- **Network** Resources settings in [Docker Desktop GUI](/manuals/desktop/settings-and-maintenance/settings.md)
557535
- Settings Management: `dnsInhibition` setting in the [`admin-settings.json` file](/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md)
536+
- Settings Management: **DNS filtering behavior** in the [Admin Console](/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md)
558537

559538
For more information, see [Networking](/manuals/desktop/features/networking.md#networking-mode-and-dns-behaviour-for-mac-and-windows).
560539

@@ -786,32 +765,6 @@ method is not yet supported by Settings Management.
786765
>
787766
> In hardened environments, disable and lock this setting to reduce interface complexity.
788767
789-
### Custom Kubernetes image repository
790-
791-
| Default value | Accepted values | Format |
792-
|---------------|-----------------|----------|
793-
| `""` | Registry URL | String |
794-
795-
- **Description**: Registry used for Kubernetes control plane images instead of Docker Hub. This allows Docker Desktop to pull Kubernetes system
796-
images from a private registry or mirror instead of Docker Hub. This setting
797-
overrides the `[registry[:port]/][namespace]` portion of image names.
798-
- **OS**: {{< badge color=blue text="All" >}}
799-
- **Use case**: Support air-gapped environments or when Docker Hub access is restricted.
800-
- **Configure this setting with**:
801-
- Settings Management: `KubernetesImagesRepository` settings in the
802-
[`admin-settings.json` file](/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md)
803-
- Settings Management: **Kubernetes Images Repository** setting in the
804-
[Admin Console](/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md)
805-
806-
> [!NOTE]
807-
>
808-
> Images must be mirrored from Docker Hub with matching tags. Required images depend on the cluster provisioning method.
809-
810-
> [!IMPORTANT]
811-
>
812-
> When using custom image repositories with Enhanced Container Isolation, add these images to the ECI allowlist: `[imagesRepository]/desktop-cloud-provider-kind:*` and
813-
`[imagesRepository]/desktop-containerd-registry-mirror:*`.
814-
815768
## Software updates settings
816769

817770
### Automatically check for updates
@@ -847,6 +800,20 @@ only internally vetted versions are installed.
847800
- **Software updates** settings in [Docker Desktop GUI](/manuals/desktop/settings-and-maintenance/settings.md)
848801
- Settings Management: **Disable updates** setting in the [Admin Console](/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md)
849802

803+
### Automatically update components
804+
805+
| Default value | Accepted values | Format |
806+
|---------------|-----------------|----------|
807+
| `true` | `true`, `false` | Boolean |
808+
809+
- **Description:** Allow Docker Desktop to automatically update components that don't require a restart.
810+
- **OS:** {{< badge color=blue text="All" >}}
811+
- **Use case:** Automatically updates key Docker Desktop components such as Docker Compose, Docker Scout, the Docker CLI.
812+
- **Configure this setting with:**
813+
- **General settings** in [Docker Desktop GUI](/manuals/desktop/settings-and-maintenance/settings.md#software-updates)
814+
- Settings Management: `silentModulesUpdate` setting in the [`admin-settings.json` file](/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md)
815+
- Settings Management: **Automatically update components** setting in the [Admin Console](/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md)
816+
850817
## Extensions settings
851818

852819
### Enable Docker extensions
@@ -910,6 +877,7 @@ third-party or unvetted plugins from being installed.
910877
- **Configure this setting with:**
911878
- **Beta** settings in [Docker Desktop GUI](/manuals/desktop/settings-and-maintenance/settings.md)
912879
- Settings Management: `enableDockerAI` setting in the [`admin-settings.json` file](/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md)
880+
- Settings Management: **Enable Docker AI** setting in the [Admin Console](/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md)
913881

914882
### Enable Docker MCP Toolkit
915883

@@ -924,27 +892,29 @@ third-party or unvetted plugins from being installed.
924892
- **Beta** settings in [Docker Desktop GUI](/manuals/desktop/settings-and-maintenance/settings.md)
925893
- Settings Management: `enableDockerMCPToolkit` setting in the [`admin-settings.json` file](/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md)
926894

927-
### Enable Wasm
895+
### Enable Docker Offload
928896

929897
| Default value | Accepted values | Format |
930898
|---------------|-----------------|----------|
931-
| `true` | `true`, `false` | Boolean |
899+
| `false` | `true`, `false` | Boolean |
932900

933-
- **Description:** Enable [Wasm](/manuals/desktop/features/wasm.md) to run Wasm workloads.
901+
- **Description:** Enable [Docker Offload](/offload/) in Docker Desktop.
934902
- **OS:** {{< badge color=blue text="All" >}}
935-
- **Use case:** Run WebAssembly applications and modules within Docker containers.
903+
- **Use case:** Offload building and running containers to the cloud.
936904
- **Configure this setting with:**
937905
- **Beta** settings in [Docker Desktop GUI](/manuals/desktop/settings-and-maintenance/settings.md)
906+
- Settings Management: `enableCloud` setting in the [`admin-settings.json` file](/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md)
907+
- Settings Management: **Enable Docker Cloud** setting in the [Admin Console](/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md)
938908

939-
### Enable Compose Bridge
909+
### Enable Wasm
940910

941911
| Default value | Accepted values | Format |
942912
|---------------|-----------------|----------|
943-
| `true` | `true`, `false` | Boolean |
913+
| `false` | `true`, `false` | Boolean |
944914

945-
- **Description:** Enable [Compose Bridge](/manuals/compose/bridge/_index.md).
915+
- **Description:** Enable [Wasm](/manuals/desktop/features/wasm.md) to run Wasm workloads.
946916
- **OS:** {{< badge color=blue text="All" >}}
947-
- **Use case:** Turn on enhanced Compose features and integrations.
917+
- **Use case:** Run WebAssembly applications and modules within Docker containers.
948918
- **Configure this setting with:**
949919
- **Beta** settings in [Docker Desktop GUI](/manuals/desktop/settings-and-maintenance/settings.md)
950920

@@ -998,7 +968,7 @@ third-party or unvetted plugins from being installed.
998968
- **Configure this setting with:**
999969
- **Notifications** settings in [Docker Desktop GUI](/manuals/desktop/settings-and-maintenance/settings.md)
1000970

1001-
### Docker Scout Notification pop-ups
971+
### Docker Scout notification pop-ups
1002972

1003973
| Default value | Accepted values | Format |
1004974
|---------------|-----------------|----------|
@@ -1064,10 +1034,21 @@ you relax this in a controlled way. See ECI Configuration for more info.
10641034
- **Configure this setting with:**
10651035
- **Advanced** settings in [Docker Desktop GUI](/manuals/desktop/settings-and-maintenance/settings.md)
10661036

1067-
## Settings not available in Docker Desktop
1037+
## Settings only available with Settings Management
10681038

10691039
The following settings aren’t shown in the Docker Desktop GUI. You can only configure them using Settings Management with the Admin Console or the `admin-settings.json` file.
10701040

1041+
### Enable Docker Cloud GPU Support
1042+
1043+
| Default value | Accepted values | Format |
1044+
|---------------|-----------------|----------|
1045+
| `true` | `true`, `false` | Boolean |
1046+
1047+
- **Description:** Enable GPU support for Docker Cloud features.
1048+
- **OS:** {{< badge color=blue text="All" >}}
1049+
- **Configure this setting with:**
1050+
- Settings Management: **Enable Docker Cloud GPU Support** setting in the [Admin Console](/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md
1051+
10711052
### Block `docker load`
10721053

10731054
| Default value | Accepted values | Format |
@@ -1079,12 +1060,25 @@ The following settings aren’t shown in the Docker Desktop GUI. You can only co
10791060
- **Use case:** Enforce image provenance by requiring all images to come from registries.
10801061
- **Configure this setting with:**
10811062
- Settings Management: `blockDockerLoad` setting in the [`admin-settings.json` file](/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md)
1063+
- Settings Management: **Block Docker Load** setting in the [Admin Console](/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md
10821064

10831065
> [!NOTE]
10841066
>
10851067
> In hardened environments, enable and lock this setting. This forces all images
10861068
to come from your secure, scanned registry.
10871069

1070+
### Hide onboarding survey
1071+
1072+
| Default value | Accepted values | Format |
1073+
|---------------|-----------------|--------|
1074+
| `false` | `true`, `false` | Boolean |
1075+
1076+
- **Description:** Prevent the onboarding survey from being shown to new users.
1077+
- **OS:** {{< badge color=blue text="All" >}}
1078+
- **Configure this setting with:**
1079+
- Settings Management: `displayedOnboarding` setting in the [`admin-settings.json` file](/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md)
1080+
- Settings Management: **Block Docker Load** setting in the [Admin Console](/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md
1081+
10881082
### Expose Docker API on TCP 2375
10891083

10901084
| Default value | Accepted values | Format |
@@ -1096,6 +1090,7 @@ to come from your secure, scanned registry.
10961090
- **Use case:** Support legacy integrations that require TCP API access.
10971091
- **Configure this setting with:**
10981092
- Settings Management: `exposeDockerAPIOnTCP2375` in the [`admin-settings.json` file](/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md)
1093+
- Settings Management: **Expose Docker API** setting in the [Admin Console](/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md
10991094

11001095
> [!NOTE]
11011096
>
@@ -1113,6 +1108,7 @@ Docker API is only reachable via the secure internal socket.
11131108
- **Use case:** Provide controlled network access for containers in offline or restricted network environments.
11141109
- **Configure this setting with:**
11151110
- Settings Management: `containersProxy` setting in the [`admin-settings.json` file](/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md)
1111+
- Settings Management: **Containers proxy** section in the [Admin Console](/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md
11161112

11171113
#### Example
11181114

@@ -1172,6 +1168,7 @@ Docker API is only reachable via the secure internal socket.
11721168
- **Use case:** Provide early access to features in development for testing and feedback.
11731169
- **Configure this setting with:**
11741170
- Settings Management: `allowBetaFeatures` setting in the [`admin-settings.json` file](/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md)
1171+
- Settings Management: **Access beta features**
11751172

11761173
> [!NOTE]
11771174
>
@@ -1222,3 +1219,55 @@ overrides are possible.
12221219
- **Use case:** Support enterprise proxy servers that require Kerberos or NTLM authentication.
12231220
- **Configure this setting with:**
12241221
- Settings Management: `proxy.enableKerberosNtlm` in the [`admin-settings.json` file](/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md)
1222+
- Settings Management: **Kerberos NTLM** setting in the [Admin Console](/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md)
1223+
1224+
### PAC file URL
1225+
1226+
| Default value | Accepted values | Format |
1227+
|---------------|-----------------|----------|
1228+
| `""` | PAC file URL | String |
1229+
1230+
- **Description:** Specifies a PAC file URL. For example, `"pac": "http://proxy/proxy.pac"`.
1231+
- **OS:** {{< badge color=blue text="All" >}}
1232+
- **Configure this setting with:**
1233+
- Settings Management: `pac` in the [`admin-settings.json` file](/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md)
1234+
- Settings Management: **PAC file** setting in the [Admin Console](/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md)
1235+
1236+
### Embedded PAC script
1237+
1238+
| Default value | Accepted values | Format |
1239+
|---------------|-----------------|----------|
1240+
| `""` | Embedded PAC script | String |
1241+
1242+
- **Description:** Specifies an embedded PAC (Proxy Auto-Config) script. For example, `"embeddedPac": "function FindProxyForURL(url, host) { return \"DIRECT\"; }"`.
1243+
- **OS:** {{< badge color=blue text="All" >}}
1244+
- **Configure this setting with:**
1245+
- Settings Management: `embeddedPac` in the [`admin-settings.json` file](/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md)
1246+
- Settings Management: **Embedded PAC script** setting in the [Admin Console](/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md)
1247+
1248+
1249+
### Custom Kubernetes image repository
1250+
1251+
| Default value | Accepted values | Format |
1252+
|---------------|-----------------|----------|
1253+
| `""` | Registry URL | String |
1254+
1255+
- **Description**: Registry used for Kubernetes control plane images instead of Docker Hub. This allows Docker Desktop to pull Kubernetes system
1256+
images from a private registry or mirror instead of Docker Hub. This setting
1257+
overrides the `[registry[:port]/][namespace]` portion of image names.
1258+
- **OS**: {{< badge color=blue text="All" >}}
1259+
- **Use case**: Support air-gapped environments or when Docker Hub access is restricted.
1260+
- **Configure this setting with**:
1261+
- Settings Management: `KubernetesImagesRepository` settings in the
1262+
[`admin-settings.json` file](/manuals/enterprise/security/hardened-desktop/settings-management/configure-json-file.md)
1263+
- Settings Management: **Kubernetes Images Repository** setting in the
1264+
[Admin Console](/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md)
1265+
1266+
> [!NOTE]
1267+
>
1268+
> Images must be mirrored from Docker Hub with matching tags. Required images depend on the cluster provisioning method.
1269+
1270+
> [!IMPORTANT]
1271+
>
1272+
> When using custom image repositories with Enhanced Container Isolation, add these images to the ECI allowlist: `[imagesRepository]/desktop-cloud-provider-kind:*` and
1273+
`[imagesRepository]/desktop-containerd-registry-mirror:*`.

0 commit comments

Comments
 (0)