Skip to content

Commit 2381c7b

Browse files
committed
final formatting
1 parent ca99eb2 commit 2381c7b

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@ Settings Management helps you control key Docker Desktop settings, like proxies
1717

1818
For an extra layer of security, you can also use Settings Management to enable and lock in [Enhanced Container Isolation](../enhanced-container-isolation/_index.md) which ensures that any configurations set with Settings Management cannot be modified by containers.
1919

20-
### Who is it for?
20+
## Who is it for?
2121

2222
- For organizations that want to configure Docker Desktop to be within their organization's centralized control.
2323
- For organizations that want to create a standardized Docker Desktop environment at scale.
2424
- For Docker Business customers who want to confidently manage their use of Docker Desktop within tightly regulated environments.
2525

26-
### How does it work?
26+
## How does it work?
2727

2828
You can configure several Docker Desktop settings using an `admin-settings.json` file. This file is located on the Docker Desktop host and can only be accessed by developers with root or administrator privileges.
2929

3030
Values that are set to `locked: true` within the `admin-settings.json` override any previous values set by developers and ensure that these cannot be modified. For more information, see [Configure Settings Management](configure.md#step-two-configure-the-settings-you-want-to-lock-in).
3131

32-
### What features can I configure with Settings Management?
32+
## What features can I configure with Settings Management?
3333

3434
Using the `admin-settings.json` file, you can:
3535

@@ -52,7 +52,7 @@ Using the `admin-settings.json` file, you can:
5252

5353
For more details on the syntax and options, see [Configure Settings Management](configure.md).
5454

55-
### How do I set up and enforce Settings Management?
55+
## How do I set up and enforce Settings Management?
5656

5757
You first need to [enforce sign-in](/manuals/security/for-admins/enforce-sign-in/_index.md) to ensure that all Docker Desktop developers authenticate with your organization. Since the Settings Management feature requires a Docker Business subscription, enforced sign-in guarantees that only authenticated users have access and that the feature consistently takes effect across all users, even though it may still work without enforced sign-in.
5858

@@ -64,7 +64,7 @@ Once this is done, Docker Desktop developers receive the changed settings when t
6464

6565
So as not to disrupt your developers' workflow, Docker doesn't automatically mandate that developers re-launch and re-authenticate once a change has been made.
6666

67-
### What do developers see when the settings are enforced?
67+
## What do developers see when the settings are enforced?
6868

6969
Enforced settings in Docker Desktop appear grayed out, making them uneditable through the Docker Desktop Dashboard, CLI, or the `settings-store.json` file (or `settings.json` for Docker Desktop versions 4.34 and earlier).
7070

content/manuals/security/for-admins/hardened-desktop/settings-management/configure.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ This page contains information on how to configure Settings Management to specif
1616

1717
Settings Management is designed specifically for organizations who don’t give developers root access to their machines.
1818

19-
### Prerequisites
19+
## Prerequisites
2020

21-
You first need to [enforce sign-in](/manuals/security/for-admins/enforce-sign-in/_index.md) to ensure that all Docker Desktop developers authenticate with your organization. Since the Settings Management feature requires a Docker Business subscription, enforced sign-in guarantees that only authenticated users have access and that the feature consistently takes effect across all users, even though it may still work without enforced sign-in.
21+
You first need to [enforce sign-in](/manuals/security/for-admins/enforce-sign-in/_index.md) to ensure that all Docker Desktop developers authenticate with your organization. Since Settings Management requires a Docker Business subscription, enforced sign-in guarantees that only authenticated users have access and that the feature consistently takes effect across all users, even though it may still work without enforced sign-in.
2222

23-
### Step one: Create the `admin-settings.json` file and save it in the correct location
23+
## Step one: Create the `admin-settings.json` file and save it in the correct location
2424

2525
You can either use the `--admin-settings` installer flag on [macOS](/manuals/desktop/setup/install/mac-install.md#install-from-the-command-line) or [Windows](/manuals/desktop/setup/install/windows-install.md#install-from-the-command-line) to automatically create the `admin-settings.json` and save it in the correct location, or set it up manually.
2626

@@ -37,7 +37,7 @@ To set it up manually:
3737
>
3838
> It is assumed that you have the ability to push the `admin-settings.json` settings file to the locations specified through a device management software such as [Jamf](https://www.jamf.com/lp/en-gb/apple-mobile-device-management-mdm-jamf-shared/?attr=google_ads-brand-search-shared&gclid=CjwKCAjw1ICZBhAzEiwAFfvFhEXjayUAi8FHHv1JJitFPb47C_q_RCySTmF86twF1qJc_6GST-YDmhoCuJsQAvD_BwE).
3939
40-
### Step two: Configure the settings you want to lock in
40+
## Step two: Configure the settings you want to lock in
4141

4242
> [!NOTE]
4343
>
@@ -183,7 +183,7 @@ The following `admin-settings.json` code and table provides an example of the re
183183
}
184184
```
185185

186-
#### General
186+
### General
187187

188188
|Parameter|OS|Description|Version|
189189
|:-------------------------------|---|:-------------------------------|---|
@@ -196,7 +196,7 @@ The following `admin-settings.json` code and table provides an example of the re
196196
| `desktopTerminalEnabled` | | If `value` is set to `false`, developers cannot use the Docker terminal to interact with the host machine and execute commands directly from Docker Desktop. | |
197197
|`exposeDockerAPIOnTCP2375`| Windows only| Exposes the Docker API on a specified port. If `value` is set to true, the Docker API is exposed on port 2375. Note: This is unauthenticated and should only be enabled if protected by suitable firewall rules.| |
198198

199-
#### File sharing and emulation
199+
### File sharing and emulation
200200

201201
|Parameter|OS|Description|Version|
202202
|:-------------------------------|---|:-------------------------------|---|
@@ -205,27 +205,27 @@ The following `admin-settings.json` code and table provides an example of the re
205205
| `useGrpcfuse` | macOS only | If `value` is set to `true`, gRPC Fuse is set as the file sharing mechanism. | |
206206
| `useVirtualizationFrameworkRosetta`| macOS only | If `value` is set to `true`, Docker Desktop turns on Rosetta to accelerate x86_64/amd64 binary emulation on Apple Silicon. Note: This also automatically enables `Use Virtualization framework`. | Docker Desktop version 4.29 and later. |
207207

208-
#### Docker Scout
208+
### Docker Scout
209209

210210
|Parameter|OS|Description|Version|
211211
|:-------------------------------|---|:-------------------------------|---|
212212
|`scout`| | Setting `useBackgroundIndexing` to `false` disables automatic indexing of images loaded to the image store. Setting `sbomIndexing` to `false` prevents users from being able to index image by inspecting them in Docker Desktop or using `docker scout` CLI commands. | |
213213

214-
#### Proxy
214+
### Proxy
215215

216216
|Parameter|OS|Description|Version|
217217
|:-------------------------------|---|:-------------------------------|---|
218218
|`proxy`| |If `mode` is set to `system` instead of `manual`, Docker Desktop gets the proxy values from the system and ignores and values set for `http`, `https` and `exclude`. Change `mode` to `manual` to manually configure proxy servers. If the proxy port is custom, specify it in the `http` or `https` property, for example `"https": "http://myotherproxy.com:4321"`. The `exclude` property specifies a comma-separated list of hosts and domains to bypass the proxy. | |
219219
|       `windowsDockerdPort`| Windows only | Exposes Docker Desktop's internal proxy locally on this port for the Windows Docker daemon to connect to. If it is set to 0, a random free port is chosen. If the value is greater than 0, use that exact value for the port. The default value is -1 which disables the option. Note: This is available for Windows containers only. | |
220220
|       `enableKerberosNtlm`| |When set to `true`, Kerberos and NTLM authentication is enabled. Default is `false`. For more information, see the settings documentation. | Docker Desktop version 4.32 and later. |
221221

222-
#### Container proxy
222+
### Container proxy
223223

224224
|Parameter|OS|Description|Version|
225225
|:-------------------------------|---|:-------------------------------|---|
226226
|`containersProxy` | | Creates air-gapped containers. For more information see [Air-Gapped Containers](../air-gapped-containers.md).| Docker Desktop version 4.29 and later. |
227227

228-
#### Linux VM
228+
### Linux VM
229229

230230
|Parameter|OS|Description|Version|
231231
|:-------------------------------|---|:-------------------------------|---|
@@ -234,27 +234,27 @@ The following `admin-settings.json` code and table provides an example of the re
234234
|        `dockerDaemonOptions` | |If `value` is set to true, it overrides the options in the Docker Engine config file. See the [Docker Engine reference](/reference/cli/dockerd/#daemon-configuration-file). Note that for added security, a few of the config attributes may be overridden when Enhanced Container Isolation is enabled. | |
235235
|        `vpnkitCIDR` | |Overrides the network range used for vpnkit DHCP/DNS for `*.docker.internal` | |
236236

237-
#### Windows containers
237+
### Windows containers
238238

239239
|Parameter|OS|Description|Version|
240240
|:-------------------------------|---|:-------------------------------|---|
241241
| `windowsContainers` | | Parameters and settings related to `windowsContainers` options - grouped together here for convenience. | |
242242
|        `dockerDaemonOptions` | | Overrides the options in the Linux daemon config file. See the [Docker Engine reference](/reference/cli/dockerd/#daemon-configuration-file).| |
243243

244-
#### Kubernetes
244+
### Kubernetes
245245

246246
|Parameter|OS|Description|Version|
247247
|:-------------------------------|---|:-------------------------------|---|
248248
|`kubernetes`| | If `enabled` is set to true, a Kubernetes single-node cluster is started when Docker Desktop starts. If `showSystemContainers` is set to true, Kubernetes containers are displayed in the Docker Desktop Dashboard and when you run `docker ps`. `imagesRepository` lets you specify which repository Docker Desktop pulls the Kubernetes images from. For example, `"imagesRepository": "registry-1.docker.io/docker"`. | |
249249

250-
#### Features in development
250+
### Features in development
251251

252252
|Parameter|OS|Description|Version|
253253
|:-------------------------------|---|:-------------------------------|---|
254254
| `allowExperimentalFeatures`| | If `value` is set to `false`, experimental features are disabled.| |
255255
| `allowBetaFeatures`| | If `value` is set to `false`, beta features are disabled.| |
256256

257-
#### Enhanced Container Isolation
257+
### Enhanced Container Isolation
258258

259259
|Parameter|OS|Description|Version|
260260
|:-------------------------------|---|:-------------------------------|---|
@@ -263,7 +263,7 @@ The following `admin-settings.json` code and table provides an example of the re
263263
|               `imageList` | | Indicates which container images are allowed to bind-mount the Docker Engine socket. | |
264264
|               `commandList` | | Restricts the commands that containers can issue via the bind-mounted Docker Engine socket. | |
265265

266-
### Step three: Re-launch Docker Desktop
266+
## Step three: Re-launch Docker Desktop
267267

268268
> [!NOTE]
269269
>

0 commit comments

Comments
 (0)