You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## Description
- Add a settings reference for a source of truth for Settings Management
and Docker Desktop settings
- Improved other Settings Management docs to link to reference and make
steps simpler
- Added hardened security recommendations to reference
*Ignore vale error*
## Related issues or tickets
https://docker.atlassian.net/browse/ENGDOCS-2581
## Reviews
- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
---------
Co-authored-by: Craig Osterhout <[email protected]>
Settings Management helps you control key Docker Desktop settings, like proxies and network configurations, on your developers' machines within your organization.
16
-
17
-
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 prevents containers from modifying any Settings Management configurations.
15
+
Settings Management lets administrators configure and enforce Docker Desktop
16
+
settings across ennd-user machines. It helps maintain consistent configurations
17
+
and enhances security within your organization.
18
18
19
19
## Who is it for?
20
20
21
-
- For organizations that want to configure Docker Desktop to be within their organization's centralized control.
22
-
- For organizations that want to create a standardized Docker Desktop environment at scale.
23
-
- For Docker Business customers who want to confidently manage their use of Docker Desktop within tightly regulated environments.
21
+
Settings Management is designed for organizations that:
22
+
23
+
- Require centralized control over Docker Desktop configurations.
24
+
- Aim to standardize Docker Desktop environments across teams.
25
+
- Operate in regulated environments and need to enforce compliance.
24
26
25
-
## How does it work?
27
+
This feature is available with a Docker Business subscription.
26
28
27
-
You can configure several Docker Desktop settings using either:
29
+
## How it works
28
30
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.
31
+
Administrators can define settings using one of the following methods:
31
32
32
-
Settings that are defined by an administrator override any previous values set by developers and ensure that these cannot be modified.
33
+
-[Admin Console](/manuals/security/for-admins/hardened-desktop/settings-management/configure-admin-console.md): Create and assign settings policies through the
34
+
Docker Admin Console.
35
+
-[`admin-settings.json` file](/manuals/security/for-admins/hardened-desktop/settings-management/configure-json-file.md): Place a configuration file on the
36
+
user's machine to enforce settings.
33
37
34
-
## What features can I configure with Settings Management?
38
+
Enforced settings override user-defined configurations and can't be modified
39
+
by developers.
35
40
36
-
Using the `admin-settings.json` file, you can:
41
+
## Configurable settings
37
42
38
-
- Turn on and lock in [Enhanced Container Isolation](../enhanced-container-isolation/_index.md)
39
-
- Configure HTTP proxies
40
-
- Configure network settings
41
-
- Configure Kubernetes settings
42
-
- Enforce the use of WSL 2 based engine or Hyper-V
43
-
- Enforce the use of Rosetta for x86_64/amd64 emulation on Apple Silicon
44
-
- Configure Docker Engine
45
-
- Turn off Docker Desktop's ability to checks for updates
46
-
- Turn off Docker Extensions
47
-
- Turn off Docker Scout SBOM indexing
48
-
- Turn off beta and experimental features
49
-
- Turn off Docker AI ([Ask Gordon](/manuals/ai/gordon/_index.md))
50
-
- Turn off Docker Desktop's onboarding survey
51
-
- Control whether developers can use the Docker terminal
52
-
- Control the file sharing implementation for your developers on macOS
53
-
- Specify which paths your developers can add file shares to
54
-
- Configure Air-gapped containers
43
+
Settings Management supports a broad range of Docker Desktop features,
44
+
including proxies, network configurations, and container isolation.
55
45
56
-
For more details on the syntax and options, see [Configure Settings Management](configure-json-file.md).
46
+
For a full list of settings you can enforce, see the [Settings reference](/manuals/security/for-admins/hardened-desktop/settings-management/settings-reference.md).
57
47
58
-
## How do I set up and enforce Settings Management?
48
+
## Set up Settings Management
59
49
60
-
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.
50
+
1.[Enforce sign-in](/manuals/security/for-admins/enforce-sign-in/_index.md) to
51
+
ensure all developers authenticate with your organization.
52
+
2. Choose a configuration method:
53
+
- 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`.
54
+
- Manually create and configure the [`admin-settings.json` file](/manuals/security/for-admins/hardened-desktop/settings-management/configure-json-file.md).
55
+
- Create a settings policy in the [Docker Admin Console](configure-admin-console.md).
61
56
62
-
Next, you must either:
63
-
- 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.
64
-
- Fill out the **Settings policy** creation form in the [Docker Admin Console](configure-admin-console.md).
57
+
After configuration, developers receive the enforced setting when they:
65
58
66
-
Once this is done, Docker Desktop developers receive the changed settings when they either:
67
-
- Quit, re-launch, and sign in to Docker Desktop
68
-
- Launch and sign in to Docker Desktop for the first time
59
+
- Quit and relaunch Docker Desktop, then sign in.
60
+
- Launch and sign in to Docker Desktop for the first time.
69
61
70
-
To avoid disrupting your developers' workflows, Docker doesn't automatically require that developers re-launch and re-authenticate once a change has been made.
62
+
> [!NOTE]
63
+
>
64
+
> Docker Desktop does not automatically prompt users to restart or re-authenticate
65
+
after a settings change.
71
66
72
-
## What do developers see when the settings are enforced?
67
+
## Developer experience
73
68
74
-
Enforced settings appear grayed out in Docker Desktop. They can't be edited via the Docker Desktop Dashboard, CLI, or `settings-store.json` (or `settings.json` for Docker Desktop 4.34 and earlier).
69
+
When settings are enforced:
75
70
76
-
In addition, if Enhanced Container Isolation is enforced, developers can't use privileged containers or similar techniques to modify enforced settings within the Docker Desktop Linux VM. For example, they can't reconfigure proxy and networking, or Docker Engine.
71
+
- Options appear grayed out in Docker Desktop and can't be modified via the
72
+
Dashboard, CLI, or configuration files.
73
+
- If Enhanced Container Isolation is enabled, developers can't use privileged
74
+
containers or similar methods to alter enforced settings within the Docker
75
+
Desktop Linux VM.
77
76
78
77
## What's next?
79
78
80
-
-[Configure Settings Management with a `.json` file](configure-json-file.md)
79
+
-[Configure Settings Management with the `admin-settings.json` file](configure-json-file.md)
81
80
-[Configure Settings Management with the Docker Admin Console](configure-admin-console.md)
81
+
82
+
## Learn more
83
+
84
+
To see how each Docker Desktop setting maps across the Docker Dashboard, `admin-settings.json` file, and Admin Console, see the [Settings reference](settings-reference.md).
Copy file name to clipboardExpand all lines: content/manuals/security/for-admins/hardened-desktop/settings-management/configure-admin-console.md
+53-43Lines changed: 53 additions & 43 deletions
Original file line number
Diff line number
Diff line change
@@ -8,68 +8,78 @@ weight: 20
8
8
9
9
{{< summary-bar feature_name="Admin Console" >}}
10
10
11
-
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.
11
+
This page explains how administrators can use the Docker Admin Console to create
12
+
and apply settings policies for Docker Desktop. These policies help standardize
13
+
and secure Docker Desktop environments across your organization.
12
14
13
15
## Prerequisites
14
16
15
-
-[Download and install Docker Desktop 4.36.0 or later](/manuals/desktop/release-notes.md).
17
+
-[Install Docker Desktop 4.36.0 or later](/manuals/desktop/release-notes.md).
16
18
-[Verify your domain](/manuals/security/for-admins/single-sign-on/configure.md#step-one-add-and-verify-your-domain).
17
-
-[Enforce sign-in](/manuals/security/for-admins/enforce-sign-in/_index.md). The Settings Management feature requires a Docker Business
18
-
subscription, therefore your Docker Desktop users must authenticate to your
19
-
organization for configurations to take effect.
19
+
-[Enforce sign-in](/manuals/security/for-admins/enforce-sign-in/_index.md) to
20
+
ensure users authenticate to your organization.
21
+
- A Docker Business subscription is required.
22
+
23
+
> [!IMPORTANT]
24
+
>
25
+
> You must add users to your verified domain for settings to take effect.
20
26
21
27
## Create a settings policy
22
28
23
-
1. Within the [Docker Admin Console](https://app.docker.com/admin) navigate to the company or organization you want to define a settings policy for.
24
-
2. Under the **Docker Desktop** section, select **Settings Management**.
29
+
1. Go to the [Docker Admin Console](https://app.docker.com/admin) and select
30
+
your organization.
31
+
2. Under **Docker Desktop**, select **Settings Management**.
25
32
3. Select **Create a settings policy**.
26
-
4.Give your settings policy a name and an optional description.
33
+
4.Provide a name and optional description.
27
34
28
-
> [!TIP]
29
-
>
30
-
> 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.
31
-
>
32
-
> Settings policies deployed via the Docker Admin Console take precedence over manually deployed `admin-settings.json` files.
35
+
> [!TIP]
36
+
>
37
+
> You can upload an existing `admin-settings.json` file to pre-fill the form.
38
+
Admin Console policies override local `admin-settings.json` files.
33
39
34
-
5. Assign the setting policy to all your users within the company or organization, or specific users.
40
+
5. Choose who the policy applies to:
41
+
- All users
42
+
- Specific users
35
43
36
-
> [!NOTE]
37
-
>
38
-
> 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.
39
-
> If a user already has a user-specific settings policy assigned, the user-specific policy takes precedence over a global policy.
44
+
> [!NOTE]
45
+
>
46
+
> User-specific policies override the global default. Test your policy with
47
+
a few users before rolling it out globally.
40
48
41
-
> [!TIP]
42
-
>
43
-
> 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.
49
+
6. Configure the state for each setting:
50
+
-**User-defined**: Users can change the setting.
51
+
-**Always enabled**: Setting is on and locked.
52
+
-**Enabled**: Setting is on but can be changed.
53
+
-**Always disabled**: Setting is off and locked.
54
+
-**Disabled**: Setting is off but can be changed.
44
55
45
-
6. Configure the settings for the policy. Go through each setting and select your chosen setting state. You can choose:
46
-
-**User-defined**. Your developers are able to control and change this setting.
47
-
-**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.
48
-
-**Enabled**. The setting is turned on and users can edit this setting from Docker Desktop or the CLI.
49
-
-**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.
50
-
-**Disabled**. The setting is turned off and users can edit this setting from Docker Desktop or the CLI.
51
-
7. Select **Create**
56
+
> [!TIP]
57
+
>
58
+
> For a complete list of available settings, their supported platforms, and which configuration methods they work with, see the [Settings reference](settings-reference.md).
52
59
53
-
For the settings policy to take effect:
54
-
- On a new install, users need to launch Docker Desktop and authenticate to their organization.
55
-
- 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.
60
+
7. Select **Create**.
56
61
57
-
> [!IMPORTANT]
58
-
>
59
-
> Selecting **Restart** from the Docker menu isn't enough as it only restarts some components of Docker Desktop.
62
+
To apply the policy:
60
63
61
-
To avoid disrupting your users' workflows, Docker doesn't automatically require that users re-launch once a change has been made.
64
+
- New installs: Launch Docker Desktop and sign in.
65
+
- Existing installs: Fully quit and relaunch Docker Desktop.
62
66
63
-
> [!NOTE]
67
+
> [!IMPORTANT]
64
68
>
65
-
> Settings are synced to Docker Desktop and the CLI when a user is signed in and starts Docker Desktop, and then every 60 minutes.
69
+
> Restarting from the Docker Desktop menu isn't enough. Users must fully quit
70
+
and relaunch Docker Desktop.
71
+
72
+
Docker Desktop checks for policy updates at launch and every 60 minutes. To roll
73
+
back a policy, either delete it or set individual settings to **User-defined**.
74
+
75
+
## Manage policies
66
76
67
-
If your settings policy needs to be rolled back, either delete the policy or edit the policy to set individual settings to **User-defined**.
77
+
From the **Actions** menu on the **Settings Management** page, you can:
68
78
69
-
## Settings policy actions
79
+
- Edit or delete an existing settings policy
80
+
- Export a settings policy as an `admin-settings.json` file
81
+
- Promote a user-specific policy to be the new global default
70
82
71
-
From the **Actions** menu on the **Settings Management** page in the Docker Admin Console, you can:
83
+
## Learn more
72
84
73
-
- Edit or delete an existing settings policy.
74
-
- Export a settings policy as an `admin-settings.json` file.
75
-
- Promote a policy that is applied to a select group of users, to be the new global default policy for all users.
85
+
To see how each Docker Desktop setting maps across the Docker Dashboard, `admin-settings.json` file, and Admin Console, see the [Settings reference](settings-reference.md).
0 commit comments