Skip to content

draft: desktop setup templates #23138

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

draft: desktop setup templates #23138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
198 changes: 198 additions & 0 deletions content/manuals/enterprise/desktop-setup-templates/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,198 @@
---
title: Desktop setup templates
description:
keywords:
params:
sidebar:
group: Enterprise
weight: 10
---

This page contains pre-configured Docker Desktop settings templates for
common enterprise deployment scenarios. Each template includes configurations
for Windows deployment (MSI), macOS deployment (PKG), and JSON file deployment
methods.

> [!WARNING]
>
> These templates are suggested starting points for different
environments. They should be reviewed, tested, and customized by your security
team before production deployment.

## How to use these templates

These templates provide starting configurations for common Docker
Desktop deployment scenarios. You can customize each template to meet
your specific secuirty and operational requirements.

Check failure on line 26 in content/manuals/enterprise/desktop-setup-templates/_index.md

View workflow job for this annotation

GitHub Actions / validate (vale) 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'secuirty'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'secuirty'?", "location": {"path": "content/manuals/enterprise/desktop-setup-templates/_index.md", "range": {"start": {"line": 26, "column": 15}}}, "severity": "ERROR"}

### Deployment workflow

1. Choose your template:
- High-security hardened: For regulated industries with strict
compliance requirements
- Standard enterprise with proxy: For corporate networks with proxy
requirements
- Windows deployment: For teams primarly developing on Windows

Check failure on line 35 in content/manuals/enterprise/desktop-setup-templates/_index.md

View workflow job for this annotation

GitHub Actions / validate (vale) 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'primarly'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'primarly'?", "location": {"path": "content/manuals/enterprise/desktop-setup-templates/_index.md", "range": {"start": {"line": 35, "column": 37}}}, "severity": "ERROR"}
with WSL 2
- Air-gapped offline: For completely isolated environments
without internet access
1. Customize the configuration:
- Review each setting and adjust based on your security policies
- Update proxy settings, registry URLs, and allowed directories
- Test thoroughly in a non-production environment first
1. Deploy using your preferred method:
- Windows (MSI): Use installer flags with `--admin-settings` parameter
- macOS (PKG): Deploy settings file before or after installation
- Manually deploy the JSON file to the appropriate directory
1. Verify and monitor settings:
- Check Docker Desktop settings UI to confirm locked values, or use
the following CLI command:
- Use Desktop settings reporting for organization-wide compliance
monitoring

## High-security hardened environment

Use this template for highly regulated industries or zero-trust environments
requiring maximum security controls. Key configurations include:

- Enhanced Container Isolation (ECI) enabled and locked
- All telemetry and analytics disabled
- Docker Extensions, beta features, and AI features disabled
- Docker load command blocked
- Desktop terminal access disabled
- Updates disabled (manual patching only)
- Strict networking controls

{{< tabs >}}
{{< tab name="Windows deployment (MSI)" >}}

```TBD```

{{< /tab >}}
{{< tab name="macOS deployment (PKG)" >}}

```TBD```

{{< /tab >}}
{{< tab name="JSON configuration file" >}}

```TBD```

{{< /tab >}}
{{< /tabs >}}

## Standard enterprise environment with proxy

Use this template for corporate environments with proxy requirements and
moderate security needs. Key configurations in this template include:

- System proxy configuration enabled
- ECI enabled but allows specific trusted images
- Analytics enabled for usage monitoring
- Extensions disabled
- Beta and AI features disabled
- Standard networking with proxy support

{{< tabs >}}
{{< tab name="Windows deployment (MSI)" >}}

```TBD```

{{< /tab >}}
{{< tab name="macOS deployment (PKG)" >}}

```TBD```

{{< /tab >}}
{{< tab name="JSON configuration file" >}}

```TBD```

{{< /tab >}}
{{< /tabs >}}

## Windows-optimized development environment

Use this template for Windows-focused development teams requiring WSL 2
integration and Windows container support. Key configurations in this template
include:

- WASL 2 engine enabled and locked

Check warning on line 120 in content/manuals/enterprise/desktop-setup-templates/_index.md

View workflow job for this annotation

GitHub Actions / validate (vale) 

[vale] reported by reviewdog 🐶
[Docker.Acronyms] 'WASL' has no definition.

Raw Output:
{"message": "[Docker.Acronyms] 'WASL' has no definition.", "location": {"path": "content/manuals/enterprise/desktop-setup-templates/_index.md", "range": {"start": {"line": 120, "column": 3}}}, "severity": "WARNING"}
- Windows container support configured
- VirtioFS for improved file sharing performance
- Kubernetes disabled
- Development-friendly file sharing paths
- Updates enabled but controlled

{{< tabs >}}
{{< tab name="Windows deployment (MSI)" >}}

```TBD```

{{< /tab >}}
{{< tab name="macOS deployment (PKG)" >}}

```TBD```

{{< /tab >}}
{{< tab name="JSON configuration file" >}}

```TBD```

{{< /tab >}}
{{< /tabs >}}

## Air-gapped offline environment

Use this template for completely isolated environments with no internet
connectivity. Key configurations in this template include:

- All online features disabled
- Container proxy configured for internal registries
- No telemetry or update checks
- Custom image repositories for Kubernetes (if necessary)
- Strict network isolation

{{< tabs >}}
{{< tab name="Windows deployment (MSI)" >}}

```TBD```

{{< /tab >}}
{{< tab name="macOS deployment (PKG)" >}}

```TBD```

{{< /tab >}}
{{< tab name="JSON configuration file" >}}

```TBD```

{{< /tab >}}
{{< /tabs >}}

## Build your configuration with AI

Use Docker's Ask AI feature to get personalized help configuring your
`admin-settings.json` file. It can help you:

- Understand what each setting does and why it matters for your environment
- Create custom configurations based on your specific requirements
- Troubleshoot deployment issues
- Convert your security policies into Docker Desktop settings

Describe your environment and requirements, and the AI will guide
you through creating your JSON configuration file.

[INSERT KAPA WIDGET]

Check warning on line 187 in content/manuals/enterprise/desktop-setup-templates/_index.md

View workflow job for this annotation

GitHub Actions / validate (vale) 

[vale] reported by reviewdog 🐶
[Docker.Acronyms] 'KAPA' has no definition.

Raw Output:
{"message": "[Docker.Acronyms] 'KAPA' has no definition.", "location": {"path": "content/manuals/enterprise/desktop-setup-templates/_index.md", "range": {"start": {"line": 187, "column": 9}}}, "severity": "WARNING"}

Example AI prompts:

- "How do I configure Docker Desktop for a financial services environment with
strict compliance requirements?"
- "What settings should I use for a development team that needs to access
internal registries through a corporate proxy?"
- "Help me create a configuration that blocks all external network access but
allows specific internal Docker registries"
- "Explain the security implications of each ECI setting in the hardened
template"
9 changes: 3 additions & 6 deletions hugo_stats.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
"Hyper-V-backend-x86_64",
"Inline",
"JSON",
"JSON-configuration-file",
"Java",
"JavaScript",
"Jenkins",
Expand Down Expand Up @@ -142,6 +143,7 @@
"Windows-Command-Prompt",
"Windows-Git-Bash",
"Windows-PowerShell",
"Windows-deployment-MSI",
"Windows-run-as-admin",
"With-packages-RPM/DEB",
"With-systemd-Highly-recommended",
Expand Down Expand Up @@ -193,7 +195,6 @@
"border-blue",
"border-divider-light",
"border-gray-200",
"border-gray-300",
"border-gray-400",
"border-green-400",
"border-l-2",
Expand Down Expand Up @@ -239,9 +240,7 @@
"dark:block",
"dark:border-b-blue-600",
"dark:border-divider-dark",
"dark:border-gray-100",
"dark:border-gray-400",
"dark:border-gray-50",
"dark:border-gray-700",
"dark:border-green-400",
"dark:border-l-magenta-dark",
Expand All @@ -266,7 +265,6 @@
"dark:text-blue-700",
"dark:text-divider-dark",
"dark:text-gray",
"dark:text-gray-100",
"dark:text-gray-200",
"dark:text-gray-300",
"dark:text-gray-400",
Expand Down Expand Up @@ -390,6 +388,7 @@
"lntd",
"m-2",
"macOS",
"macOS-deployment-PKG",
"max-h-full",
"max-w-4xl",
"max-w-56",
Expand Down Expand Up @@ -554,7 +553,6 @@
"text-gray-300",
"text-gray-400",
"text-gray-500",
"text-gray-600",
"text-gray-800",
"text-left",
"text-lg",
Expand All @@ -579,7 +577,6 @@
"underline-offset-2",
"w-2",
"w-5",
"w-56",
"w-65",
"w-8",
"w-[1200px]",
Expand Down