Skip to content

Commit 23589f1

Browse files
security: caveats for admin-settings.json (#22441)
## Description - admin-settings.json required sign in & business subscription, or the file will not apply settings - updated prereqs to be clearer, added a known limitations section for air-gapped containers or regulated environments that can't authenticate ## Related issues or tickets - [ENGDOCS-2563](https://docker.atlassian.net/browse/ENGDOCS-2563) ## Reviews - [ ] Product review - [ ] Editorial review [ENGDOCS-2563]: https://docker.atlassian.net/browse/ENGDOCS-2563?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --------- Co-authored-by: Craig Osterhout <[email protected]>
1 parent 9fbb168 commit 23589f1

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

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

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,23 @@ Settings Management is designed specifically for organizations who don’t give
1717

1818
## Prerequisites
1919

20-
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.
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.
23+
24+
> [!IMPORTANT]
25+
>
26+
> 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+
28+
29+
## Known limitations
30+
31+
The `admin-settings.json` file requires users to authenticate with Docker Hub and be a member
32+
of an organization with a Docker Business subscription. This means the file does not work in:
33+
34+
- Air-grapped or offline environments where Docker Desktop can't authenticate with Docker Hub.
35+
- Restricted environments where SSO and cloud-based authentication are not permitted.
36+
2137

2238
## Step one: Create the `admin-settings.json` file and save it in the correct location
2339

hugo_stats.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"-v",
1414
"-z-10",
1515
".NET",
16+
"AWS-Route-53",
1617
"Admin-Console",
1718
"After",
1819
"Angular",
@@ -53,6 +54,8 @@
5354
"Git-Bash-CLI",
5455
"GitLab",
5556
"Go",
57+
"GoDaddy",
58+
"Google-Cloud-DNS",
5659
"HTTP",
5760
"Heredocs",
5861
"Hyper-V-backend-x86_64",
@@ -82,6 +85,7 @@
8285
"Okta",
8386
"Okta-SAML",
8487
"Old-Dockerfile",
88+
"Other-providers",
8589
"PHP",
8690
"PowerShell",
8791
"PowerShell-CLI",

0 commit comments

Comments
 (0)