Skip to content

Commit 64a3458

Browse files
authored
Update references to settings.json to reflect new name (#21003)
<!--Delete sections as needed --> ## 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. <!-- Tell us what you did and why --> ## Related issues or tickets https://docker.atlassian.net/browse/DS-1506 <!-- Related issues, pull requests, or Jira tickets --> ## Reviews <!-- Notes for reviewers here --> <!-- List applicable reviews (optionally @tag reviewers) --> - [x] Technical review @ebriney @aiordache - [x] Editorial review @aevesdocker - [x] Product review @KatTomrushka
1 parent 0413296 commit 64a3458

File tree

6 files changed

+20
-20
lines changed

6 files changed

+20
-20
lines changed

content/manuals/desktop/settings.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ To navigate to **Settings** either:
1616
- Select the Docker menu {{< inline-image src="images/whale-x.svg" alt="whale menu" >}} and then **Settings**
1717
- Select the **Settings** icon from the Docker Desktop Dashboard.
1818

19-
You can also locate the `settings.json` file at:
20-
- Mac: `~/Library/Group Containers/group.com.docker/settings.json`
21-
- Windows: `C:\Users\[USERNAME]\AppData\Roaming\Docker\settings.json`
22-
- Linux: `~/.docker/desktop/settings.json`
19+
You can also locate the `settings-store.json` file (or `settings.json` for Docker Desktop versions 4.34 and earlier) at:
20+
- Mac: `~/Library/Group Containers/group.com.docker/settings-store.json`
21+
- Windows: `C:\Users\[USERNAME]\AppData\Roaming\Docker\settings-store.json`
22+
- Linux: `~/.docker/desktop/settings-store.json`
2323

2424
## General
2525

content/manuals/desktop/troubleshoot/topics.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ Docker Desktop uses hardware-accelerated graphics by default, which may cause pr
4242
Docker Desktop will launch successfully, but some screens may appear green, distorted,
4343
or have some visual artifacts.
4444

45-
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:
45+
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:
4646

47-
- Mac: `~/Library/Group Containers/group.com.docker/settings.json`
48-
- Windows: `C:\Users\[USERNAME]\AppData\Roaming\Docker\settings.json`
49-
- Linux: `~/.docker/desktop/settings.json.`
47+
- Mac: `~/Library/Group Containers/group.com.docker/settings-store.json`
48+
- Windows: `C:\Users\[USERNAME]\AppData\Roaming\Docker\settings-store.json`
49+
- Linux: `~/.docker/desktop/settings-store.json.`
5050

51-
After updating the `settings.json` file, close and restart Docker Desktop to apply the changes.
51+
After updating the `settings-store.json` file, close and restart Docker Desktop to apply the changes.
5252

5353
## Topics for Linux and Mac
5454

@@ -109,7 +109,7 @@ in the Apple documentation, and Docker Desktop [Mac system requirements](../inst
109109

110110
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.
111111

112-
To continue using VPNKit, add `"networkType":"vpnkit"` to your `settings.json` file located at `~/Library/Group Containers/group.com.docker/settings.json`.
112+
To continue using VPNKit, add `"networkType":"vpnkit"` to your `settings-store.json` file located at `~/Library/Group Containers/group.com.docker/settings-store.json`.
113113

114114
## Topics for Windows
115115

content/manuals/desktop/use-desktop/resource-saver.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ timer as shown below.
2424

2525
If the values available aren't sufficient for your
2626
needs, you can reconfigure it to any value, as long as the value is larger than 30 seconds, by
27-
changing `autoPauseTimeoutSeconds` in the Docker Desktop `settings.json` file:
27+
changing `autoPauseTimeoutSeconds` in the Docker Desktop `settings-store.json` file (or `settings.json` for Docker Desktop versions 4.34 and earlier):
2828

29-
- Mac: `~/Library/Group Containers/group.com.docker/settings.json`
30-
- Windows: `C:\Users\[USERNAME]\AppData\Roaming\Docker\settings.json`
31-
- Linux: `~/.docker/desktop/settings.json`
29+
- Mac: `~/Library/Group Containers/group.com.docker/settings-store.json`
30+
- Windows: `C:\Users\[USERNAME]\AppData\Roaming\Docker\settings-store.json`
31+
- Linux: `~/.docker/desktop/settings-store.json`
3232

3333
There's no need to restart Docker Desktop after reconfiguring.
3434

content/manuals/extensions/settings-feedback.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ Docker Extensions is switched on by default. To change your settings:
2121

2222
>**Note**
2323
>
24-
> 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`.
25-
> The `settings.json` file is located at:
26-
> - `~/Library/Group Containers/group.com.docker/settings.json` on Mac
27-
> - `C:\Users\[USERNAME]\AppData\Roaming\Docker\settings.json` on Windows
24+
> 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`.
25+
> The `settings-store.json` file (or `settings.json` for Docker Desktop versions 4.34 and earlier) is located at:
26+
> - `~/Library/Group Containers/group.com.docker/settings-store.json` on Mac
27+
> - `C:\Users\[USERNAME]\AppData\Roaming\Docker\settings-store.json` on Windows
2828
>
2929
> This can also be done with [Hardened Docker Desktop](/manuals/security/for-admins/hardened-desktop/_index.md)
3030

content/manuals/security/for-admins/hardened-desktop/settings-management/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Docker doesn't automatically mandate that developers re-launch and re-authentica
7676

7777
### What do developers see when the settings are enforced?
7878

79-
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.
79+
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.
8080

8181
![Proxy settings grayed out](/assets/images/grayed-setting.png)
8282

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ If `locked: true`, users aren't able to edit this setting from Docker Desktop or
5959
If `locked: false`, it's similar to setting a factory default in that:
6060
- For new installs, `locked: false` pre-populates the relevant settings in the Docker Desktop UI, but users are able to modify it.
6161

62-
- 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`.
62+
- 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`.
6363

6464
The following `admin-settings.json` code and table provides an example of the required syntax and descriptions for parameters and values:
6565

0 commit comments

Comments
 (0)