From f4376ff8a01d6b6d12bdb19488bda945e520e922 Mon Sep 17 00:00:00 2001 From: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Date: Mon, 4 Dec 2023 16:07:04 +0000 Subject: [PATCH] ENGDOCS-1875 (#18788) * ENGDOCS-1875 * another admin setting * fix table formatting * review edits --- .../settings-management/_index.md | 1 + .../settings-management/configure.md | 19 +++++++++++++++++-- content/desktop/settings/linux.md | 10 +++++----- content/desktop/settings/mac.md | 13 +++++++------ content/desktop/settings/windows.md | 13 +++++++------ content/desktop/use-desktop/builds.md | 2 +- data/toc.yaml | 4 +++- 7 files changed, 41 insertions(+), 21 deletions(-) diff --git a/content/desktop/hardened-desktop/settings-management/_index.md b/content/desktop/hardened-desktop/settings-management/_index.md index 3a67b59147..db79b139cc 100644 --- a/content/desktop/hardened-desktop/settings-management/_index.md +++ b/content/desktop/hardened-desktop/settings-management/_index.md @@ -40,6 +40,7 @@ Using the `admin-settings.json` file, admins can: - 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 For more details on the syntax and options admins can set, see [Configure Settings Management](configure.md). diff --git a/content/desktop/hardened-desktop/settings-management/configure.md b/content/desktop/hardened-desktop/settings-management/configure.md index f6225371ff..9302859b33 100644 --- a/content/desktop/hardened-desktop/settings-management/configure.md +++ b/content/desktop/hardened-desktop/settings-management/configure.md @@ -106,13 +106,25 @@ The following `admin-settings.json` code and table provides an example of the re "value": true }, "extensionsEnabled": { - "value": false, - "locked": true + "locked": true, + "value": false }, "scout": { "locked": false, "sbomIndexing": true, "useBackgroundIndexing": true + }, + "allowExperimentalFeatures": { + "locked": false, + "value": false + }, + "allowBetaFeatures": { + "locked": false, + "value": false + }, + "blockDockerLoad": { + "locked": false, + "value": true } } ``` @@ -135,6 +147,9 @@ The following `admin-settings.json` code and table provides an example of the re |`analyticsEnabled`| |If `value` is set to false, Docker Desktop doesn't send usage statistics to Docker. | |`extensionsEnabled`| |If `value` is set to false, Docker extensions are disabled. | |`scout`|| Setting `useBackgroundIndexing` to `false` disables automatic indexing of images loaded to the image store. Setting `sbomIndexing` to `false` prevents the manual indexing triggered by inspecting an image in Docker Desktop.

**Note**: Users can still use the `docker scout` CLI commands to index images, even if indexing is disabled in Settings Management. | +| `allowExperimentalFeatures`| | If `value` is set to `false`, experimental features are disabled.| +| `allowBetaFeatures`| | If `value` is set to `false`, beta features are disabled.| +| `blockDockerLoad` | | If `value` is set to `true`, users are no longer able to run [`docker load`](../../../engine/reference/commandline/load.md) and receive an error if they try to.| ### Step three: Re-launch Docker Desktop >**Note** diff --git a/content/desktop/settings/linux.md b/content/desktop/settings/linux.md index fefed31768..fe202c6ced 100644 --- a/content/desktop/settings/linux.md +++ b/content/desktop/settings/linux.md @@ -18,10 +18,13 @@ You can also locate the `settings.json` file at `~/.docker/desktop/settings.json On the **General** tab, you can configure when to start Docker and specify other settings: -- **Start Docker Desktop when you log in**. Select to automatically start Docker +- **Start Docker Desktop when you sign in**. Select to automatically start Docker Desktop when you sign in to your machine. -- **Choose Theme for Docker Desktop**. Choose whether you want to apply a **Light** or **Dark** theme to Docker Desktop. Alternatively you can set Docker Desktop to **Use System Settings**. +- **Open Docker Dashboard when Docker Desktop starts**. Select to automatically open the + dashboard when starting Docker Desktop. + +- **Choose theme for Docker Desktop**. Choose whether you want to apply a **Light** or **Dark** theme to Docker Desktop. Alternatively you can set Docker Desktop to **Use System Settings**. - **Choose container terminal**. Determines which terminal is launched when opening the terminal from a container. If you choose the integrated terminal, you can run commands in a running container straight from the Docker Dashboard. For more information, see [Explore containers](../use-desktop/container.md). @@ -34,9 +37,6 @@ If you choose the integrated terminal, you can run commands in a running contain - **Show weekly tips**. Select to display useful advice and suggestions about using Docker. -- **Open Docker Desktop dashboard at startup**. Select to automatically open the - dashboard when starting Docker Desktop. - - **Use Enhanced Container Isolation**. Select to enhance security by preventing containers from breaching the Linux VM. For more information, see [Enhanced Container Isolation](../hardened-desktop/enhanced-container-isolation/index.md) >**Note** > diff --git a/content/desktop/settings/mac.md b/content/desktop/settings/mac.md index af9178130a..ecc7d4a118 100644 --- a/content/desktop/settings/mac.md +++ b/content/desktop/settings/mac.md @@ -23,10 +23,13 @@ You can also locate the `settings.json` file at `~/Library/Group Containers/grou On the **General** tab, you can configure when to start Docker and specify other settings: -- **Start Docker Desktop when you log in**. Select to automatically start Docker +- **Start Docker Desktop when you sign in**. Select to automatically start Docker Desktop when you sign in to your machine. -- **Choose Theme for Docker Desktop**. Choose whether you want to apply a **Light** or **Dark** theme to Docker Desktop. Alternatively you can set Docker Desktop to **Use System Settings**. +- **Open Docker Dashboard when Docker Desktop starts**. Select to automatically open the + dashboard when starting Docker Desktop. + +- **Choose theme for Docker Desktop**. Choose whether you want to apply a **Light** or **Dark** theme to Docker Desktop. Alternatively you can set Docker Desktop to **Use System Settings**. - **Choose container terminal**. Determines which terminal is launched when opening the terminal from a container. If you choose the integrated terminal, you can run commands in a running container straight from the Docker Dashboard. For more information, see [Explore containers](../use-desktop/container.md). @@ -46,7 +49,6 @@ If you choose the integrated terminal, you can run commands in a running contain > Use VirtioFS for speedy file sharing. VirtioFS has reduced the time taken to complete filesystem operations by [up to 98%](https://github.com/docker/roadmap/issues/7#issuecomment-1044452206) { .tip } - - **Use Rosetta for x86/AMD64 emulation on Apple Silicon**. Turns on Rosetta to accelerate x86/AMD64 binary emulation on Apple Silicon. This option is only available if you have turned on **Virtualization framework** in the **General** settings tab. You must also be on macOS Ventura or later. - **Send usage statistics**. Select so Docker Desktop sends diagnostics, @@ -57,9 +59,6 @@ If you choose the integrated terminal, you can run commands in a running contain - **Show weekly tips**. Select to display useful advice and suggestions about using Docker. -- **Open Docker Desktop dashboard at startup**. Select to automatically open the - dashboard when starting Docker Desktop. - - **Use Enhanced Container Isolation**. Select to enhance security by preventing containers from breaching the Linux VM. For more information, see [Enhanced Container Isolation](../hardened-desktop/enhanced-container-isolation/index.md). >**Note** > @@ -199,6 +198,8 @@ The HTTPS proxy settings used for scanning images are set using the `HTTPS_PROXY {{< include "desktop-network-setting.md" >}} +You can also select **Use kernel networking for UDP**. This lets you use a more efficient kernel networking path for UDP by changing the value of `kernelForUDP` in the `settings.json` file. + ## Docker Engine The **Docker Engine** tab allows you to configure the Docker daemon used to run containers with Docker Desktop. diff --git a/content/desktop/settings/windows.md b/content/desktop/settings/windows.md index 769a3496be..a3d76b223c 100644 --- a/content/desktop/settings/windows.md +++ b/content/desktop/settings/windows.md @@ -18,12 +18,16 @@ You can also locate the `settings.json` file at `C:\Users\[USERNAME]\AppData\Roa On the **General** tab, you can configure when to start Docker and specify other settings: -- **Start Docker Desktop when you log in**. Select to automatically start Docker +- **Start Docker Desktop when you sign in**. Select to automatically start Docker Desktop when you sign in to your machine. -- **Choose Theme for Docker Desktop**. Choose whether you want to apply a **Light** or **Dark** theme to Docker Desktop. Alternatively you can set Docker Desktop to **Use System Settings**. +- **Open Docker Dashboard when Docker Desktop starts**. Select to automatically open the + dashboard when starting Docker Desktop. -- **Use integrated container terminal**. Select to execute commands in a running container straight from the Docker Dashboard. For more information, see [Explore containers](../use-desktop/container.md). +- **Choose theme for Docker Desktop**. Choose whether you want to apply a **Light** or **Dark** theme to Docker Desktop. Alternatively you can set Docker Desktop to **Use System Settings**. + +- **Choose container terminal**. Determines which terminal is launched when opening the terminal from a container. +If you choose the integrated terminal, you can run commands in a running container straight from the Docker Dashboard. For more information, see [Explore containers](../use-desktop/container.md). - **Expose daemon on tcp://localhost:2375 without TLS**. Check this option to enable legacy clients to connect to the Docker daemon. You must use this option @@ -43,9 +47,6 @@ On the **General** tab, you can configure when to start Docker and specify other - **Show weekly tips**. Select to display useful advice and suggestions about using Docker. -- **Open Docker Desktop dashboard at startup**. Select to automatically open the - dashboard when starting Docker Desktop. - - **Use Enhanced Container Isolation**. Select to enhance security by preventing containers from breaching the Linux VM. For more information, see [Enhanced Container Isolation](../hardened-desktop/enhanced-container-isolation/index.md) >**Note** > diff --git a/content/desktop/use-desktop/builds.md b/content/desktop/use-desktop/builds.md index 8bf9137331..2b97b0b598 100644 --- a/content/desktop/use-desktop/builds.md +++ b/content/desktop/use-desktop/builds.md @@ -1,5 +1,5 @@ --- -title: Explore Builds (Beta) +title: Explore Builds description: Understand how to use the Builds view in Docker Desktop keywords: Docker Dashboard, manage, gui, dashboard, builders, builds --- diff --git a/data/toc.yaml b/data/toc.yaml index 691b9220c6..792ead2940 100644 --- a/data/toc.yaml +++ b/data/toc.yaml @@ -1139,7 +1139,7 @@ Manuals: - path: /desktop/use-desktop/volumes/ title: Explore Volumes - path: /desktop/use-desktop/builds/ - title: Explore Builds (Beta) + title: Explore Builds - path: /desktop/use-desktop/resource-saver/ title: Resource Saver mode - path: /desktop/use-desktop/pause/ @@ -1253,6 +1253,8 @@ Manuals: title: Manage non-Marketplace extensions - path: /desktop/extensions/settings-feedback/ title: Change settings and give feedback + - path: /desktop/extensions/private-marketplace/ + title: Configure a private marketplace (Beta) - sectiontitle: Extensions SDK section: - path: /desktop/extensions-sdk/