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
Copy file name to clipboardExpand all lines: content/manuals/security/for-admins/hardened-desktop/settings-management/_index.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,8 +43,10 @@ by developers and ensure that these cannot be modified.
43
43
## What features can I configure with Settings Management?
44
44
45
45
You can configure a wide range of features, from proxies and Kubernetes settings
46
-
to Enhanced Container isolation. For more information, view the [full list of
47
-
configurable settings]().
46
+
to Enhanced Container isolation. For more information, view the [Settings reference](/manuals/security/for-admins/hardened-desktop/settings-management/settings-reference.md).
47
+
48
+
The settings reference outlines what settings can be configured with the [Admin
49
+
Console](/manuals/security/for-admins/hardened-desktop/settings-management/configure-admin-console.md) or [`admin-settings.json` file](/manuals/security/for-admins/hardened-desktop/settings-management/configure-json-file.md).
48
50
49
51
## How do I set up and enforce Settings Management?
Copy file name to clipboardExpand all lines: content/manuals/security/for-admins/hardened-desktop/settings-management/configure-json-file.md
+6-9Lines changed: 6 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,15 +17,13 @@ Settings Management is designed specifically for organizations who don’t give
17
17
18
18
## Prerequisites
19
19
20
-
You must [enforce sign-in](/manuals/security/for-admins/enforce-sign-in/_index.md) to ensure that all Docker Desktop users authenticate with your organization.
21
-
22
-
Settings management requires a Docker Business subscription. Docker Desktop verifies the user's authentication and licensing before applying any settings from the `admin-settings.json` file. The settings file will not take effect unless both authentication and license checks pass. These checks ensure that only licensed users receive managed settings.
20
+
- You must [enforce sign-in](/manuals/security/for-admins/enforce-sign-in/_index.md) to ensure that all Docker Desktop users authenticate with your organization.
21
+
- Settings management requires a Docker Business subscription. Docker Desktop verifies the user's authentication and licensing before applying any settings from the `admin-settings.json` file. The settings file will not take effect unless both authentication and license checks pass. These checks ensure that only licensed users receive managed settings.
23
22
24
23
> [!IMPORTANT]
25
24
>
26
25
> If a user is not signed in, or their Docker ID does not belong to an organization with a Docker Business subscription, Docker Desktop ignores the `admin-settings.json` file.
27
26
28
-
29
27
## Known limitations
30
28
31
29
The `admin-settings.json` file requires users to authenticate with Docker Hub and be a member
@@ -34,8 +32,7 @@ of an organization with a Docker Business subscription. This means the file does
34
32
- Air-grapped or offline environments where Docker Desktop can't authenticate with Docker Hub.
35
33
- Restricted environments where SSO and cloud-based authentication are not permitted.
36
34
37
-
38
-
## Step one: Create the `admin-settings.json` file and save it in the correct location
35
+
## Step one: Create the `admin-settings.json` file and save it
39
36
40
37
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.
41
38
@@ -52,7 +49,7 @@ To set it up manually:
52
49
>
53
50
> 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).
54
51
55
-
## Step two: Configure the settings you want to lock in
52
+
## Step two: Configure settings
56
53
57
54
> [!NOTE]
58
55
>
@@ -64,7 +61,6 @@ If `locked: true`, users aren't able to edit this setting from Docker Desktop or
64
61
65
62
If `locked: false`, it's similar to setting a factory default in that:
66
63
- For new installs, `locked: false` pre-populates the relevant settings in the Docker Desktop Dashboard, but users are able to modify it.
67
-
68
64
- If Docker Desktop is already installed and being used, `locked: false` is ignored. This is because existing users of Docker Desktop may have already updated a setting, which in turn will have been written to the relevant config file, for example the `settings-store.json` (or `settings.json` for Docker Desktop versions 4.34 and earlier) or `daemon.json`. In these instances, the user's preferences are respected and the values aren't altered. These can be controlled by setting `locked: true`.
69
65
70
66
The following `admin-settings.json` code and table provides an example of the required syntax and descriptions for parameters and values:
@@ -301,10 +297,11 @@ The following `admin-settings.json` code and table provides an example of the re
301
297
For settings to take effect:
302
298
- On a new install, developers need to launch Docker Desktop and authenticate to their organization.
303
299
- On an existing install, developers 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.
300
+
304
301
> [!IMPORTANT]
305
302
>
306
303
> Selecting **Restart** from the Docker menu isn't enough as it only restarts some components of Docker Desktop.
307
304
308
-
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.
305
+
To avoid disrupting your developers' workflow, Docker doesn't automatically mandate that developers re-launch and re-authenticate once a change has been made.
309
306
310
307
In Docker Desktop, developers see the relevant settings grayed out.
Copy file name to clipboardExpand all lines: content/manuals/security/for-admins/hardened-desktop/settings-management/settings-reference.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -796,9 +796,9 @@ Docker-in-Docker or containerized CI agents.
796
796
-**Configure this setting with:**
797
797
-**Advanced** settings in [Docker Desktop GUI](/manuals/desktop/settings-and-maintenance/settings.md)
798
798
799
-
## Settings not available in the Docker Desktop UI
799
+
## Settings not available in the Docker Desktop GUI
800
800
801
-
The following settings aren’t shown in the Docker Desktop UI. You can only configure them using Settings Management with the Admin Console or the `admin-settings.json` file.
801
+
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.
0 commit comments