Skip to content

Commit 53569a8

Browse files
mat007usha-mandya
mat007
and
usha-mandya
authored
Update Docker Desktop admin settings documentation (docker#10665)
* Update admin settings documentation for file sharing * Format JSON samples Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
1 parent a9a6c22 commit 53569a8

File tree

2 files changed

+72
-62
lines changed

2 files changed

+72
-62
lines changed

‎desktop/enterprise/admin/configure/mac-admin.md

Lines changed: 37 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ The following `admin-settings.json` code and table provide the required syntax a
3535

3636
```json
3737
{
38-
"configurationFileVersion": 1,
39-
"analyticsEnabled": {
38+
"configurationFileVersion": 2,
39+
"analyticsEnabled": {
4040
"locked": false,
4141
"value": false
42-
},
42+
},
4343
"dockerCliOptions": {
4444
"stackOrchestrator": {
4545
"locked": false,
@@ -54,10 +54,10 @@ The following `admin-settings.json` code and table provide the required syntax a
5454
"exclude": "docker.com,github.com"
5555
}
5656
},
57-
"linuxVM": {
58-
"cpus": {
59-
"locked": false,
60-
"value": 2
57+
"linuxVM": {
58+
"cpus": {
59+
"locked": false,
60+
"value": 2
6161
},
6262
"memoryMiB": {
6363
"locked": false,
@@ -67,27 +67,22 @@ The following `admin-settings.json` code and table provide the required syntax a
6767
"locked": false,
6868
"value": 1024
6969
},
70-
"dataFolder" : {
71-
"locked" : false,
72-
"value" : "/Users/..."
70+
"dataFolder": {
71+
"locked": false,
72+
"value": "/Users/..."
7373
},
7474
"diskSizeMiB": {
7575
"locked": false,
7676
"value": 65536
7777
},
78-
"filesharingDirectories": {
79-
"locked":false,
80-
"value":["/Users", "..."]
81-
},
8278
"dockerDaemonOptions": {
8379
"experimental": {
84-
"locked": false,
85-
"value": true
80+
"locked": false,
81+
"value": true
8682
}
8783
}
8884
},
8985
"kubernetes": {
90-
9186
"enabled": {
9287
"locked": false,
9388
"value": false
@@ -105,19 +100,30 @@ The following `admin-settings.json` code and table provide the required syntax a
105100
"value": null
106101
}
107102
},
108-
109-
"template" : {
110-
"defaultOrg" : {"value": "myorg", "locked":true},
111-
"defaultRegistry" : {"value": "mydtr:5000", "locked":true},
112-
"repositories": {
113-
"value": [
114-
"https://one/library.yaml",
115-
"https://two/library.yaml",
116-
"https://three/library.yaml"
117-
],
118-
"locked" : true
119-
}
103+
"template": {
104+
"defaultOrg": {
105+
"value": "myorg",
106+
"locked": true
107+
},
108+
"defaultRegistry": {
109+
"value": "mydtr:5000",
110+
"locked": true
120111
},
112+
"repositories": {
113+
"value": [
114+
"https://one/library.yaml",
115+
"https://two/library.yaml",
116+
"https://three/library.yaml"
117+
],
118+
"locked": true
119+
}
120+
},
121+
"filesharingDirectories": {
122+
"locked": false,
123+
"value": [
124+
"/Users"
125+
]
126+
}
121127
}
122128
```
123129

@@ -135,7 +141,6 @@ Parameter values and descriptions for environment configuration on Mac:
135141
| `swapMiB` | Specifies the amount of memory in MiB (1 MiB = 1048576 bytes) allocated for the swap file. |
136142
| `dataFolder` | Specifies the directory containing the VM disk files. |
137143
| `diskSizeMiB` | Specifies the amount of disk storage in MiB (1 MiB = 1048576 bytes) allocated for images and containers. |
138-
| `filesharingDirectories` | The host folders that users can bind-mount in containers. |
139144
| `dockerDaemonOptions` | Overrides the options in the linux daemon config file. For more information, see [Docker engine reference](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file). |
140145
| (End of `linuxVM` section.) | |
141146
| `kubernetes` | Parameters and settings related to kubernetes options - grouped together here for convenience. |
@@ -148,6 +153,8 @@ Parameter values and descriptions for environment configuration on Mac:
148153
|`defaultOrg`| Specifies the default organization to be used in Docker Template and Docker Application Designer. If `locked` is set to `true`, the Kubernetes cluster starts when Docker Desktop Enterprise is started. |
149154
|`defaultRegistry`|Specifies the default registry to be used in Docker Template and Application Designer.|
150155
|`repositories`|Lists the repositories that are allowed.|
156+
| `filesharingDirectories` | The host folders that users can bind-mount in containers. |
157+
=======
151158

152159
### File format update
153160

‎desktop/enterprise/admin/configure/windows-admin.md

Lines changed: 35 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,15 @@ The following `admin-settings.json` code and table provide the required syntax a
4141

4242
```json
4343
{
44-
"configurationFileVersion": 1,
44+
"configurationFileVersion": 2,
4545
"engine": {
4646
"locked": false,
4747
"value": "linux"
4848
},
4949
"analyticsEnabled": {
5050
"locked": false,
5151
"value": false
52-
},
52+
},
5353
"exposeDockerAPIOnTCP2375": {
5454
"locked": false,
5555
"value": false
@@ -68,7 +68,6 @@ The following `admin-settings.json` code and table provide the required syntax a
6868
"exclude": "docker.com,github.com"
6969
}
7070
},
71-
7271
"linuxVM": {
7372
"cpus": {
7473
"locked": false,
@@ -95,9 +94,9 @@ The following `admin-settings.json` code and table provide the required syntax a
9594
"value": "10.0.75.0/28"
9695
},
9796
"vpnkitCIDR": {
98-
"locked": false,
99-
"value": "192.168.65.0/28"
100-
},
97+
"locked": false,
98+
"value": "192.168.65.0/28"
99+
},
101100
"useDnsForwarder": {
102101
"locked": false,
103102
"value": true
@@ -108,18 +107,17 @@ The following `admin-settings.json` code and table provide the required syntax a
108107
},
109108
"dockerDaemonOptions": {
110109
"experimental": {
111-
"locked": false,
112-
"value": true
110+
"locked": false,
111+
"value": true
113112
}
114113
}
115114
},
116-
117115
"windows": {
118116
"dockerDaemonOptions": {
119-
"experimental": {
120-
"locked": false,
121-
"value": true
122-
}
117+
"experimental": {
118+
"locked": false,
119+
"value": true
120+
}
123121
}
124122
},
125123
"kubernetes": {
@@ -140,25 +138,30 @@ The following `admin-settings.json` code and table provide the required syntax a
140138
"value": null
141139
}
142140
},
143-
144-
"template" : {
145-
"defaultOrg" : {"value": "myorg", "locked":true},
146-
"defaultRegistry" : {"value": "mydtr:5000", "locked":true},
147-
"repositories": {
148-
"value": [
149-
"https://one/library.yaml",
150-
"https://two/library.yaml",
151-
"https://three/library.yaml"
152-
],
153-
"locked" : true
154-
}
141+
"template": {
142+
"defaultOrg": {
143+
"value": "myorg",
144+
"locked": true
155145
},
156-
157-
"sharedDrives": {
158-
"locked": true,
159-
"value": [ ]
146+
"defaultRegistry": {
147+
"value": "mydtr:5000",
148+
"locked": true
149+
},
150+
"repositories": {
151+
"value": [
152+
"https://one/library.yaml",
153+
"https://two/library.yaml",
154+
"https://three/library.yaml"
155+
],
156+
"locked": true
157+
}
160158
},
161-
"sharedFolders": ["%USERPROFILE%", "\\\\.\\pipe\\docker_engine"]
159+
"filesharingDirectories": {
160+
"locked": false,
161+
"value": [
162+
"%USERPROFILE%"
163+
]
164+
}
162165
}
163166
```
164167

@@ -197,8 +200,7 @@ Parameter values and descriptions for environment configuration on Windows:
197200
|`defaultOrg`| Specifies the default organization to be used in Docker Template and Docker Application Designer. If `locked` is set to `true`, the Kubernetes cluster starts when Docker Desktop Enterprise is started. |
198201
|`defaultRegistry`|Specifies the default registry to be used in Docker Template and Application Designer.|
199202
|`repositories`|Lists the repositories that are allowed.|
200-
| `sharedDrives` | If `sharedDrives` is set to `true`, this locks the drives users are allowed to share ( `["C", "D"]` ), but does not actually share drives by default (sharing a drive prompts the user for a password). `value` is a whitelist of drives that can be shared. **Warning:** Note that when updating this value, if you remove drives that have been shared, you must also `net share /delete` those drives. |
201-
| `sharedFolders` | If specified, restricts the folders or named pipes the user is allowed to share with Windows containers. |
203+
| `filesharingDirectories` | The host folders that users can bind-mount in containers. |
202204

203205
### File format update
204206

@@ -245,3 +247,4 @@ Otherwise manual steps are required to update the `admin-settings.json` file.
245247
}
246248
}
247249
```
250+

0 commit comments

Comments
 (0)