Skip to content

Commit 42d97aa

Browse files
authored
ENGDOCS-2181c (#21419)
<!--Delete sections as needed --> ## Description Replaces #20646 that was so old it was still using the `toc.yaml` file. SME reviews complete. Just need editorial ## Related issues or tickets <!-- Related issues, pull requests, or Jira tickets --> ## Reviews <!-- Notes for reviewers here --> <!-- List applicable reviews (optionally @tag reviewers) --> - [ ] Technical review - [x] Editorial review - [ ] Product review
1 parent 5c12f4f commit 42d97aa

File tree

8 files changed

+117
-18
lines changed

8 files changed

+117
-18
lines changed

content/guides/admin-set-up/comms-and-info-gathering.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Some companies may have more than one [Docker organization](/manuals/admin/organ
2626

2727
Through [Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/_index.md), Docker provides numerous configuration parameters that can be preset. The Docker organization owner, development lead, and infosec representative should review these settings to establish the company’s baseline configuration, including security features and [enforcing sign-in](/manuals/security/for-admins/enforce-sign-in/_index.md) for Docker Desktop users. Additionally, they should decide whether to take advantage of free trials for other Docker products, such as [Docker Scout](/manuals/scout/_index.md), which is included in the subscription.
2828

29-
To view the parameters that can be preset, see [Configure Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/configure.md#step-two-configure-the-settings-you-want-to-lock-in).
29+
To view the parameters that can be preset, see [Configure Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/configure-json-file.md#step-two-configure-the-settings-you-want-to-lock-in).
3030

3131
## Optional step four: Meet with the Docker Implementation team
3232

content/manuals/desktop/release-notes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -615,7 +615,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st
615615

616616
### New
617617

618-
- You can now enforce Rosetta usage via [Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/configure.md).
618+
- You can now enforce Rosetta usage via [Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/_index.md).
619619
- [Docker socket mount restrictions](/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation/config.md) with ECI is now generally available.
620620
- Docker Engine and CLI updated to [Moby 26.0](https://github.com/moby/moby/releases/tag/v26.0.0). This includes Buildkit 0.13, sub volumes mounts, networking updates, and improvements to the containerd multi-platform image store UX.
621621
- New and improved Docker Desktop error screens: swift troubleshooting, easy diagnostics uploads, and actionable remediation.
@@ -913,7 +913,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st
913913

914914
### New
915915

916-
- Administrators can now control access to beta and experimental features in the **Features in development** tab with [Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/configure.md).
916+
- Administrators can now control access to beta and experimental features in the **Features in development** tab with [Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/_index.md).
917917
- Introduced four new version update states in the footer.
918918
- `docker init` (Beta) now supports PHP with Apache + Composer.
919919
- The [**Builds** view](use-desktop/builds.md) is now GA. You can now inspect builds, troubleshoot errors, and optimize build speed.
@@ -1023,7 +1023,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st
10231023
- Rosetta is now Generally Available for all users on macOS 13 or later. It provides faster emulation of Intel-based images on Apple Silicon. To use Rosetta, see [Settings](/manuals/desktop/settings-and-maintenance/settings.md). Rosetta is enabled by default on macOS 14.1 and later.
10241024
- Docker Desktop now detects if a WSL version is out of date. If an out dated version of WSL is detected, you can allow Docker Desktop to automatically update the installation or you can manually update WSL outside of Docker Desktop.
10251025
- New installations of Docker Desktop for Windows now require a Windows version of 19044 or later.
1026-
- Administrators now have the ability to control Docker Scout image analysis in [Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/configure.md).
1026+
- Administrators now have the ability to control Docker Scout image analysis in [Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/_index.md).
10271027

10281028
### Upgrades
10291029

content/manuals/scout/release-notes/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,7 @@ Discarded in favor of [1.9.1](#191).
410410
instance by Docker Desktop there's no need anymore to re-index it on WSL2
411411
side.
412412
- Indexing is now blocked in the CLI if it has been disabled using
413-
[Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/configure.md) feature.
413+
[Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/_index.md) feature.
414414

415415
- Fix a panic that would occur when analyzing a single-image `oci-dir` input
416416
- Improve local attestation support with the containerd image store

content/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation/_index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Enforcing sign-in ensures that your Docker Desktop developers always authenticat
106106

107107
##### Setup
108108

109-
[Create and configure the `admin-settings.json` file](../settings-management/configure.md) and specify:
109+
[Create and configure the `admin-settings.json` file](/manuals/security/for-admins/hardened-desktop/settings-management/configure-json-file.md) and specify:
110110

111111
```json
112112
{
@@ -135,6 +135,10 @@ For this to take effect:
135135
>
136136
> Selecting **Restart** from the Docker menu isn't enough as it only restarts some components of Docker Desktop.
137137
138+
> [!TIP]
139+
>
140+
> You can now also configure these settings in the [Docker Admin Console](/manuals/security/for-admins/hardened-desktop/settings-management/configure-admin-console.md).
141+
138142
### What do users see when this setting is enforced by an admin?
139143

140144
When Enhanced Container Isolation is enabled, users see:

content/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation/config.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Starting with Docker Desktop 4.27, admins can optionally configure ECI to allow
3939
bind mounting the Docker Engine socket into containers, but in a controlled way.
4040

4141
This can be done via the Docker Socket mount permissions section in the
42-
[admin-settings.json](../settings-management/configure.md) file. For example:
42+
[admin-settings.json](../settings-management/_index.md) file. For example:
4343

4444
```json
4545
{
@@ -64,6 +64,10 @@ This can be done via the Docker Socket mount permissions section in the
6464
}
6565
```
6666

67+
> [!TIP]
68+
>
69+
> You can now also configure these settings in the [Docker Admin Console](/manuals/security/for-admins/hardened-desktop/settings-management/configure-admin-console.md).
70+
6771
As shown above, there are two configurations for bind-mounting the Docker
6872
socket into containers: the `imageList` and the `commandList`. These are
6973
described below.

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

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,11 @@ For an extra layer of security, you can also use Settings Management to enable a
2525

2626
## How does it work?
2727

28-
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.
28+
You can configure several Docker Desktop settings using either:
29+
- 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.
30+
- Creating a settings policy in the Docker Admin Console
2931

30-
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).
32+
Settings that are defined by an administrator override any previous values set by developers and ensure that these cannot be modified.
3133

3234
## What features can I configure with Settings Management?
3335

@@ -50,13 +52,15 @@ Using the `admin-settings.json` file, you can:
5052
- Specify which paths your developers can add file shares to
5153
- Configure Air-gapped containers
5254

53-
For more details on the syntax and options, see [Configure Settings Management](configure.md).
55+
For more details on the syntax and options, see [Configure Settings Management](configure-json-file.md).
5456

5557
## How do I set up and enforce Settings Management?
5658

5759
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.
5860

59-
Next, you must either manually [create and configure the admin-settings.json file](configure.md), or 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.
61+
Next, you must either:
62+
- Manually [create and configure the `admin-settings.json` file](configure-json-file.md), or 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.
63+
- Fill out the **Settings policy** creation form in the [Docker Admin Console](configure-admin-console.md).
6064

6165
Once this is done, Docker Desktop developers receive the changed settings when they either:
6266
- Quit, re-launch, and sign in to Docker Desktop
@@ -72,6 +76,7 @@ In addition, if Enhanced Container Isolation is enforced, developers can't use p
7276

7377
![Proxy settings grayed out](/assets/images/grayed-setting.png)
7478

75-
## More resources
79+
## What's next?
7680

77-
- [Video: Settings Management](https://www.youtube.com/watch?v=I9oJOJ1P9PQ)
81+
- [Configure Settings Management with a `.json` file](configure-json-file.md)
82+
- [Configure Settings Management with the Docker Admin Console](configure-admin-console.md)
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
description: How to configure Settings Management for Docker Desktop using the Docker Admin Console
3+
keywords: admin, controls, rootless, enhanced container isolation
4+
title: Configure Settings Management with the Admin Console
5+
linkTitle: Use the Admin Console
6+
weight: 20
7+
params:
8+
sidebar:
9+
badge:
10+
color: violet
11+
text: EA
12+
---
13+
14+
{{% restricted title="Early Access" %}}
15+
Settings Management in the Docker Admin Console is an [early access](/release-lifecycle#early-access-ea) feature and is available to Docker Business customers only.
16+
{{% /restricted %}}
17+
18+
This page contains information for administrators on how to configure Settings Management with the Docker Admin Console. You can specify and lock configuration parameters to create a standardized Docker Desktop environment across your Docker company or organization.
19+
20+
## Prerequisites
21+
22+
- [Download and install Docker Desktop 4.36.0 or later](/manuals/desktop/release-notes.md).
23+
- [Verify your domain](/manuals/security/for-admins/single-sign-on/configure.md#step-one-add-and-verify-your-domain).
24+
- [Enforce sign-in](/manuals/security/for-admins/enforce-sign-in/_index.md). The Settings Management feature requires a Docker Business
25+
subscription, therefore your Docker Desktop users must authenticate to your
26+
organization for configurations to take effect.
27+
28+
## Create a settings policy
29+
30+
1. Within the [Docker Admin Console](https://admin.docker.com/) navigate to the company or organization you want to define a settings policy for.
31+
2. Under the **Security and access** section, select **Desktop Settings Management**.
32+
3. In the top-right corner, select **Create a settings policy**.
33+
4. Give your settings policy a name and an optional description.
34+
35+
> [!TIP]
36+
>
37+
> If you have already configured Settings Management with an `admin-settings.json` file for an organization, you can upload it using the **Upload existing settings** button which then automatically populates the form for you.
38+
>
39+
> Settings policies deployed via the Docker Admin Console take precedence over manually deployed `admin-settings.json` files.
40+
41+
5. Assign the setting policy to all your users within the company or organization, or specific users.
42+
43+
> [!NOTE]
44+
>
45+
> If a settings policy is assigned to all users, it sets the policy as the global default policy. You can only have one global settings policy at a time.
46+
> If a user already has a user-specific settings policy assigned, the user-specific policy takes precedence over a global policy.
47+
48+
> [!TIP]
49+
>
50+
> Before setting a global settings policy, it is recommended that you first test it as a user-specific policy to make sure you're happy with the changes before proceeding.
51+
52+
6. Configure the settings for the policy. Go through each setting and select your chosen setting state. You can choose:
53+
- **User-defined**. Your developers are able to control and change this setting.
54+
- **Always enabled**. This means the setting is turned on and your users won't be able to edit this setting from Docker Desktop or the CLI.
55+
- **Enabled**. The setting is turned on and users can edit this setting from Docker Desktop or the CLI.
56+
- **Always disabled**. This means the setting is turned off and your users won't be able to edit this setting from Docker Desktop or the CLI.
57+
- **Disabled**. The setting is turned off and users can edit this setting from Docker Desktop or the CLI.
58+
7. Select **Create**
59+
60+
For the settings policy to take effect:
61+
- On a new install, users need to launch Docker Desktop and authenticate to their organization.
62+
- On an existing install, users need to quit Docker Desktop through the Docker menu, and then re-launch Docker Desktop. If they are already signed in, they don't need to sign in again for the changes to take effect.
63+
64+
> [!IMPORTANT]
65+
>
66+
> Selecting **Restart** from the Docker menu isn't enough as it only restarts some components of Docker Desktop.
67+
68+
To avoid disrupting your users' workflows, Docker doesn't automatically require that users re-launch once a change has been made.
69+
70+
> [!NOTE]
71+
>
72+
> Settings are synced to Docker Desktop and the CLI when a user is signed in and starts Docker Desktop, and then every 60 minutes.
73+
74+
If your settings policy needs to be rolled back, either delete the policy or edit the policy to set individual settings to **User-defined**.
75+
76+
## Settings policy actions
77+
78+
From the **Actions** menu on the **Desktop Settings Management** page in the Docker Admin Console, you can:
79+
- Edit or delete an existing settings policy.
80+
- Export a settings policy as an `admin-settings.json` file.
81+
- Promote a policy that is applied to a select group of users, to be the new global default policy for all users.

content/manuals/security/for-admins/hardened-desktop/settings-management/configure.md renamed to content/manuals/security/for-admins/hardened-desktop/settings-management/configure-json-file.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
---
22
description: How to configure Settings Management for Docker Desktop
33
keywords: admin, controls, rootless, enhanced container isolation
4-
title: Configure Settings Management
5-
linkTitle: Configure
6-
toc_min: 4
4+
title: Configure Settings Management with a JSON file
5+
linkTitle: Use a JSON file
6+
weight: 10
77
aliases:
88
- /desktop/hardened-desktop/settings-management/configure/
9+
- /security/for-admins/hardened-desktop/settings-management/configure/
910
---
1011

1112
> [!NOTE]
1213
>
1314
> Settings Management is available to Docker Business customers only.
1415
15-
This page contains information on how to configure Settings Management to specify and lock configuration parameters to create a standardized Docker Desktop environment across the organization.
16+
This page contains information on how to configure Settings Management with an `admin-settings.json` file. You can specify and lock configuration parameters to create a standardized Docker Desktop environment across your company or organization.
1617

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

@@ -41,7 +42,7 @@ To set it up manually:
4142

4243
> [!NOTE]
4344
>
44-
> Some of the configuration parameters only apply to Windows or to specific Docker Desktop versions. This is highlighted in the following table.
45+
> Some of the configuration parameters only apply to certain platforms or to specific Docker Desktop versions. This is highlighted in the following table.
4546
4647
The `admin-settings.json` file requires a nested list of configuration parameters, each of which must contain the `locked` parameter. You can add or remove configuration parameters as per your requirements.
4748

@@ -241,6 +242,10 @@ The following `admin-settings.json` code and table provides an example of the re
241242
| `windowsContainers` | | Parameters and settings related to `windowsContainers` options - grouped together here for convenience. | |
242243
| &nbsp; &nbsp; &nbsp; &nbsp;`dockerDaemonOptions` | | Overrides the options in the Linux daemon config file. See the [Docker Engine reference](/reference/cli/dockerd/#daemon-configuration-file).| |
243244

245+
> [!NOTE]
246+
>
247+
> This setting is not available to configure via the Docker Admin Console.
248+
244249
### Kubernetes
245250

246251
|Parameter|OS|Description|Version|

0 commit comments

Comments
 (0)