From 64a3458c914f39ce15b29d732018510eb32fd0eb Mon Sep 17 00:00:00 2001 From: Craig Gumbley Date: Thu, 24 Oct 2024 16:14:39 +0100 Subject: [PATCH] Update references to settings.json to reflect new name (#21003) ## Description As part of the settings management project, settings.json has been renamed to settings-store.json. This change updates the public docs so that they reflect the new name. ## Related issues or tickets https://docker.atlassian.net/browse/DS-1506 ## Reviews - [x] Technical review @ebriney @aiordache - [x] Editorial review @aevesdocker - [x] Product review @KatTomrushka --- content/manuals/desktop/settings.md | 8 ++++---- content/manuals/desktop/troubleshoot/topics.md | 12 ++++++------ .../manuals/desktop/use-desktop/resource-saver.md | 8 ++++---- content/manuals/extensions/settings-feedback.md | 8 ++++---- .../hardened-desktop/settings-management/_index.md | 2 +- .../settings-management/configure.md | 2 +- 6 files changed, 20 insertions(+), 20 deletions(-) diff --git a/content/manuals/desktop/settings.md b/content/manuals/desktop/settings.md index 81c53f2019..2c2b2831d9 100644 --- a/content/manuals/desktop/settings.md +++ b/content/manuals/desktop/settings.md @@ -16,10 +16,10 @@ To navigate to **Settings** either: - Select the Docker menu {{< inline-image src="images/whale-x.svg" alt="whale menu" >}} and then **Settings** - Select the **Settings** icon from the Docker Desktop Dashboard. -You can also locate the `settings.json` file at: - - Mac: `~/Library/Group Containers/group.com.docker/settings.json` - - Windows: `C:\Users\[USERNAME]\AppData\Roaming\Docker\settings.json` - - Linux: `~/.docker/desktop/settings.json` +You can also locate the `settings-store.json` file (or `settings.json` for Docker Desktop versions 4.34 and earlier) at: + - Mac: `~/Library/Group Containers/group.com.docker/settings-store.json` + - Windows: `C:\Users\[USERNAME]\AppData\Roaming\Docker\settings-store.json` + - Linux: `~/.docker/desktop/settings-store.json` ## General diff --git a/content/manuals/desktop/troubleshoot/topics.md b/content/manuals/desktop/troubleshoot/topics.md index e92534096f..40c611da64 100644 --- a/content/manuals/desktop/troubleshoot/topics.md +++ b/content/manuals/desktop/troubleshoot/topics.md @@ -42,13 +42,13 @@ Docker Desktop uses hardware-accelerated graphics by default, which may cause pr Docker Desktop will launch successfully, but some screens may appear green, distorted, or have some visual artifacts. -To work around this issue, disable hardware acceleration by creating a `"disableHardwareAcceleration": true` entry in Docker Desktop's `settings.json` file. You can find this file at: +To work around this issue, disable hardware acceleration by creating a `"disableHardwareAcceleration": true` entry in Docker Desktop's `settings-store.json` file (or `settings.json` for Docker Desktop versions 4.34 and earlier). You can find this file at: -- Mac: `~/Library/Group Containers/group.com.docker/settings.json` -- Windows: `C:\Users\[USERNAME]\AppData\Roaming\Docker\settings.json` -- Linux: `~/.docker/desktop/settings.json.` +- Mac: `~/Library/Group Containers/group.com.docker/settings-store.json` +- Windows: `C:\Users\[USERNAME]\AppData\Roaming\Docker\settings-store.json` +- Linux: `~/.docker/desktop/settings-store.json.` -After updating the `settings.json` file, close and restart Docker Desktop to apply the changes. +After updating the `settings-store.json` file, close and restart Docker Desktop to apply the changes. ## Topics for Linux and Mac @@ -109,7 +109,7 @@ in the Apple documentation, and Docker Desktop [Mac system requirements](../inst In Docker Desktop version 4.19, gVisor replaced VPNKit to enhance the performance of VM networking when using the Virtualization framework on macOS 13 and above. -To continue using VPNKit, add `"networkType":"vpnkit"` to your `settings.json` file located at `~/Library/Group Containers/group.com.docker/settings.json`. +To continue using VPNKit, add `"networkType":"vpnkit"` to your `settings-store.json` file located at `~/Library/Group Containers/group.com.docker/settings-store.json`. ## Topics for Windows diff --git a/content/manuals/desktop/use-desktop/resource-saver.md b/content/manuals/desktop/use-desktop/resource-saver.md index 9dfea55756..929163bf23 100644 --- a/content/manuals/desktop/use-desktop/resource-saver.md +++ b/content/manuals/desktop/use-desktop/resource-saver.md @@ -24,11 +24,11 @@ timer as shown below. If the values available aren't sufficient for your needs, you can reconfigure it to any value, as long as the value is larger than 30 seconds, by -changing `autoPauseTimeoutSeconds` in the Docker Desktop `settings.json` file: +changing `autoPauseTimeoutSeconds` in the Docker Desktop `settings-store.json` file (or `settings.json` for Docker Desktop versions 4.34 and earlier): - - Mac: `~/Library/Group Containers/group.com.docker/settings.json` - - Windows: `C:\Users\[USERNAME]\AppData\Roaming\Docker\settings.json` - - Linux: `~/.docker/desktop/settings.json` + - Mac: `~/Library/Group Containers/group.com.docker/settings-store.json` + - Windows: `C:\Users\[USERNAME]\AppData\Roaming\Docker\settings-store.json` + - Linux: `~/.docker/desktop/settings-store.json` There's no need to restart Docker Desktop after reconfiguring. diff --git a/content/manuals/extensions/settings-feedback.md b/content/manuals/extensions/settings-feedback.md index d233d19e5d..c430289f7a 100644 --- a/content/manuals/extensions/settings-feedback.md +++ b/content/manuals/extensions/settings-feedback.md @@ -21,10 +21,10 @@ Docker Extensions is switched on by default. To change your settings: >**Note** > -> If you are an [organization owner](/manuals/admin/organization/manage-a-team.md#organization-owner), you can turn off extensions for your users. Open the `settings.json` file, and set `"extensionsEnabled"` to `false`. -> The `settings.json` file is located at: -> - `~/Library/Group Containers/group.com.docker/settings.json` on Mac -> - `C:\Users\[USERNAME]\AppData\Roaming\Docker\settings.json` on Windows +> If you are an [organization owner](/manuals/admin/organization/manage-a-team.md#organization-owner), you can turn off extensions for your users. Open the `settings-store.json` file, and set `"extensionsEnabled"` to `false`. +> The `settings-store.json` file (or `settings.json` for Docker Desktop versions 4.34 and earlier) is located at: +> - `~/Library/Group Containers/group.com.docker/settings-store.json` on Mac +> - `C:\Users\[USERNAME]\AppData\Roaming\Docker\settings-store.json` on Windows > > This can also be done with [Hardened Docker Desktop](/manuals/security/for-admins/hardened-desktop/_index.md) diff --git a/content/manuals/security/for-admins/hardened-desktop/settings-management/_index.md b/content/manuals/security/for-admins/hardened-desktop/settings-management/_index.md index 65f45d4984..03cd8324bf 100644 --- a/content/manuals/security/for-admins/hardened-desktop/settings-management/_index.md +++ b/content/manuals/security/for-admins/hardened-desktop/settings-management/_index.md @@ -76,7 +76,7 @@ Docker doesn't automatically mandate that developers re-launch and re-authentica ### What do developers see when the settings are enforced? -Any settings that are enforced, are grayed out in Docker Desktop and the user is unable to edit them, either via the Docker Desktop UI, CLI, or the `settings.json` file. In addition, if Enhanced Container Isolation is enforced, developers can't use privileged containers or similar techniques to modify enforced settings within the Docker Desktop Linux VM, for example, reconfigure proxy and networking of reconfigure Docker Engine. +Any settings that are enforced, are grayed out in Docker Desktop and the user is unable to edit them, either via the Docker Desktop UI, CLI, or the `settings-store.json` file (or `settings.json` for Docker Desktop versions 4.34 and earlier). In addition, if Enhanced Container Isolation is enforced, developers can't use privileged containers or similar techniques to modify enforced settings within the Docker Desktop Linux VM, for example, reconfigure proxy and networking of reconfigure Docker Engine. ![Proxy settings grayed out](/assets/images/grayed-setting.png) diff --git a/content/manuals/security/for-admins/hardened-desktop/settings-management/configure.md b/content/manuals/security/for-admins/hardened-desktop/settings-management/configure.md index ad5feca71c..01e34698c5 100644 --- a/content/manuals/security/for-admins/hardened-desktop/settings-management/configure.md +++ b/content/manuals/security/for-admins/hardened-desktop/settings-management/configure.md @@ -59,7 +59,7 @@ If `locked: true`, users aren't able to edit this setting from Docker Desktop or If `locked: false`, it's similar to setting a factory default in that: - For new installs, `locked: false` pre-populates the relevant settings in the Docker Desktop UI, but users are able to modify it. -- 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.json` or `daemon.json`. In these instances, the user's preferences are respected and we don't alter these values. These can be controlled by the admin by setting `locked: true`. +- 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 we don't alter these values. These can be controlled by the admin by setting `locked: true`. The following `admin-settings.json` code and table provides an example of the required syntax and descriptions for parameters and values: