Skip to content

security: add settings reference #22625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
May 14, 2025
+1,218 −138
Merged

security: add settings reference #22625

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
0eb855c
add settings reference
sarahsanders-docker May 12, 2025
d9ce4ea
add note about usage statistics
sarahsanders-docker May 13, 2025
b698ac9
fix missing section, add security best practices
sarahsanders-docker May 14, 2025
3cc5eb6
fix whitespace for linting errors
sarahsanders-docker May 14, 2025
d18b1fe
final review/proofread, improvements to settings mangement guides
sarahsanders-docker May 14, 2025
d2f6f3f
Update content/manuals/security/for-admins/hardened-desktop/settings-…
sarahsanders-docker May 14, 2025
bebd681
feedback on notes
sarahsanders-docker May 14, 2025
6358697
Merge branch 'main' into settings-reference
sarahsanders-docker May 14, 2025
efef4ff
remove hugo stats
sarahsanders-docker May 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 5 additions & 21 deletions content/manuals/security/for-admins/hardened-desktop/settings-management/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,27 +33,11 @@

## What features can I configure with Settings Management?

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

- Turn on and lock in [Enhanced Container Isolation](../enhanced-container-isolation/_index.md)
- Configure HTTP proxies
- Configure network settings
- Configure Kubernetes settings
- Enforce the use of WSL 2 based engine or Hyper-V
- Enforce the use of Rosetta for x86_64/amd64 emulation on Apple Silicon
- Configure Docker Engine
- Turn off Docker Desktop's ability to checks for updates
- Turn off Docker Extensions
- Turn off Docker Scout SBOM indexing
- Turn off beta and experimental features
- Turn off Docker AI ([Ask Gordon](/manuals/ai/gordon/_index.md))
- Turn off Docker Desktop's onboarding survey
- Control whether developers can use the Docker terminal
- Control the file sharing implementation for your developers on macOS
- Specify which paths your developers can add file shares to
- Configure Air-gapped containers

For more details on the syntax and options, see [Configure Settings Management](configure-json-file.md).
You can configure a wide range of features, from proxies and Kubernetes settings
to Enhanced Container isolation. For more information, view the [Settings reference](/manuals/security/for-admins/hardened-desktop/settings-management/settings-reference.md).

The settings reference outlines what settings can be configured with the [Admin

Check warning on line 39 in content/manuals/security/for-admins/hardened-desktop/settings-management/_index.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Docker.RecommendedWords] Consider using 'administrator' instead of 'Admin'

Raw Output:
{"message": "[Docker.RecommendedWords] Consider using 'administrator' instead of 'Admin'", "location": {"path": "content/manuals/security/for-admins/hardened-desktop/settings-management/_index.md", "range": {"start": {"line": 39, "column": 75}}}, "severity": "INFO"}
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).

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

Expand Down
4 changes: 4 additions & 0 deletions ...rity/for-admins/hardened-desktop/settings-management/configure-admin-console.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ This page contains information for administrators on how to configure Settings M
subscription, therefore your Docker Desktop users must authenticate to your
organization for configurations to take effect.

> [!IMPORTANT]
>
> For settings to take effect, you must add users to your verified domain.

## Create a settings policy

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.
Expand Down
4 changes: 2 additions & 2 deletions ...security/for-admins/hardened-desktop/settings-management/configure-json-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ of an organization with a Docker Business subscription. This means the file does
- Restricted environments where SSO and cloud-based authentication are not permitted.


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

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.

Expand All @@ -52,7 +52,7 @@ To set it up manually:
>
> 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).

## Step two: Configure the settings you want to lock in
## Step two: Configure settings

> [!NOTE]
>
Expand Down
Loading
Loading