Skip to content

Commit 1adb279

Browse files
authored
Merge pull request #1323 from ryanrichter94/orgguide
Add Docs For SkipChocolateyGUI & IncludePackageTools Parameters
2 parents d4cb7d2 + 048f6fc commit 1adb279

1 file changed

Lines changed: 24 additions & 8 deletions

File tree

  • src/content/docs/en-us/guides/organizations/organizational-deployment-guide

src/content/docs/en-us/guides/organizations/organizational-deployment-guide/client-setup.mdx

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import OrgGuideClientSetupIntro from '@components/docs/OrgGuideClientSetupIntro.
1919
Chocolatey provides a suggested installation and configuration script along with the rest of the organizational guide. It's available [in the choco-orgguide-scripts repository](https://github.com/chocolatey/choco-orgguide-scripts/blob/main/ClientSetup.ps1).
2020
</Callout>
2121

22-
### Usage
22+
## Usage
2323

2424
You can download and run the script in one of two ways - fill out the values below, and select the tab closest to your environment:
2525

@@ -32,7 +32,6 @@ You can download and run the script in one of two ways - fill out the values bel
3232
| Chocolatey Central Management Service Salt | <DynamicCodeBlockInput name="OrgGuideCcmServiceSalt" defaultValue="ServiceCommunicationSalt" /> | Used to secure communication to the Chocolatey Central Management service. |
3333
| Chocolatey Central Management Client Salt | <DynamicCodeBlockInput name="OrgGuideCcmClientSalt" defaultValue="ClientCommunicationSalt" /> | Used to secure communication to the Chocolatey Central Management service. |
3434

35-
3635
export const clientsetupscenarios = [
3736
{ id: 'repo,ccm', title: 'Repository and Chocolatey Central Management', isActive: true },
3837
{ id: 'repo', title: 'Repository Only' },
@@ -160,13 +159,29 @@ You can also save the script to your client machine and run it with the same par
160159
`}
161160
</DynamicCodeBlock>
162161

163-
### Setup Modification
162+
## Setup Modification
164163

165164
You can additionally use this script to add configuration, packages, and more.
166165

167166
By passing arguments to `AdditionalConfiguration`, `AdditionalFeatures`, `AdditionalSources`, and `AdditionalPackages` you can additively configure your Chocolatey client - or you can add lines directly to the Client Setup script and deploy that.
168167

169-
#### Configuration
168+
### Include Packaging Tools with Installation
169+
170+
Some members of your team may be responsible for maintaining Chocolatey packages in your organization. These tools can be included in the installation by providing the `-IncludePackageTools` parameter.
171+
172+
```powershell
173+
.\ClientSetup.ps1 @ScriptArgs -IncludePackageTools
174+
```
175+
176+
### Skip Chocolatey GUI Installation
177+
178+
Some machines within your organization might not require the installation of the self-service Chocolatey GUI application. Examples of these types of machines may include Windows servers with no GUI interface, or digital signage/kiosk thin clients. You can skip installation of the Chocolatey GUI application by providing the `-SkipChocolateyGUI` parameter.
179+
180+
```powershell
181+
.\ClientSetup.ps1 @ScriptArgs -IncludePackageTools -SkipChocolateyGUI
182+
```
183+
184+
### Configuration
170185

171186
You can adjust any Chocolatey configuration value by adding an `-AdditionalConfiguration` argument to your Client Setup script invocation.
172187

@@ -179,7 +194,7 @@ You can adjust any Chocolatey configuration value by adding an `-AdditionalConfi
179194

180195
This can override the base configuration we provide in the client setup.
181196

182-
#### Features
197+
### Features
183198

184199
You can adjust any Chocolatey feature by adding an `-AdditionalFeatures` argument to your Client Setup script invocation.
185200

@@ -191,7 +206,7 @@ You can adjust any Chocolatey feature by adding an `-AdditionalFeatures` argumen
191206

192207
This can override the base features we provide in the client setup.
193208

194-
#### Sources
209+
### Sources
195210

196211
You can add any additional sources you desire by adding the `-AdditionalSources` argument to your Client Setup script invocation.
197212

@@ -215,7 +230,7 @@ Only the `Source` and `Credential` parts of the passed object are required, ever
215230

216231
This can override the sources we create in the client setup.
217232

218-
#### Packages
233+
### Packages
219234

220235
You can install additional packages during the Client Setup script invocation.
221236

@@ -233,6 +248,7 @@ Only the `Id` part of the passed object is required, everything else is optional
233248

234249
If you find yourself wanting to perform more complex installations, e.g. using parameters, we would recommend adding them to the script itself.
235250
<Xref title="Back To Top" value="organizational-client-setup"/>
251+
236252
## Next Steps
237253

238254
Select **Start Over** to return to the Organizational Guide introduction page, or select **Previous** to return to Automation Solution setup.
@@ -242,4 +258,4 @@ Select **Start Over** to return to the Organizational Guide introduction page, o
242258
<div>
243259
<a role="button" class="btn btn-primary btn-lg" href="/en-us/guides/organizations/organizational-deployment-guide/setup-central-management">< Previous</a>
244260
</div>
245-
</div>
261+
</div>

0 commit comments

Comments
 (0)