Skip to content

Commit e40d031

Browse files
Merge pull request #1322 from ryanrichter94/QSG-SkipGUI
Document -SkipChocolateyGUI Parameter in Advanced Client Config
2 parents 574d8f4 + 5580c8a commit e40d031

2 files changed

Lines changed: 25 additions & 8 deletions

File tree

.vscode/settings.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
"gemcutter",
4141
"gitextensions",
4242
"Gitter",
43+
"hashtable",
4344
"HKEY",
4445
"HKLM",
4546
"honor",

src/content/docs/en-us/c4b-environments/quick-start-environment/advanced-client-configuration.mdx

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ While this opinionated approach is fine for most situations, flexibility is requ
1616

1717
These credentials are found in the README file placed on the Desktop of the server during installation, or wherever you documented them if you changed them after installation.
1818
</Callout>
19+
1920
## Include Packaging Tools with installation
2021

2122
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.
@@ -25,12 +26,21 @@ Set-Location /path/to/register-c4bendpoint.ps1
2526
. .\Register-C4bEndpoint.ps1 -RepositoryCredential (Get-Credential) -IncludePackageTools
2627
```
2728

29+
## Skip Chocolatey GUI installation
30+
31+
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.
32+
33+
```powershell
34+
Set-Location /path/to/register-c4bendpoint.ps1
35+
. .\Register-C4bEndpoint.ps1 -RepositoryCredential (Get-Credential) -SkipChocolateyGUI
36+
```
37+
2838
## Enable/Disable additional features with installation
2939

3040
Some endpoints may require a different set of features. The default installation will apply our _recommended_ configuration.
3141
However, you can override these defaults or enable/disable additional features by providing the `-AdditionalFeatures` parameter.
3242

33-
In this example we will disable the use of the background service so non-admin users cannot use Chocolatey (not recommended), and enable Gloabl Confirmation so you no longer need to pass -y when performing a package operation.
43+
In this example we will disable the use of the background service so non-admin users cannot use Chocolatey (not recommended), and enable Global Confirmation so you no longer need to pass -y when performing a package operation.
3444

3545
```powershell
3646
Set-Location /path/to/register-c4bendpoint.ps1
@@ -51,7 +61,8 @@ Set-Location /path/to/register-c4bendpoint.ps1
5161

5262
You can include additional Chocolatey sources during the installation process by providing the `-AdditionalSources` parameter.
5363

54-
#### Include a group repository source
64+
### Include a group repository source
65+
5566
In this example we will add a new source called Engineering, which is a group source configured on the repository server
5667
that contains a repository for Engineering-specific packages, with a base repository of general use packages.
5768

@@ -60,7 +71,7 @@ Set-Location /path/to/register-c4bendpoint.ps1
6071
. .\Register-C4bEndpoint.ps1 -RepositoryCredential (Get-Credential) -AdditionalSources @{Name = 'Engineering'; Source = 'https://repo.fabrikam.com/repository/EngineeringGroup/index.json'}
6172
```
6273

63-
#### Include a local source
74+
### Include a local source
6475

6576
<Callout type="warning">
6677
The local folder must exist prior to using this source.
@@ -90,7 +101,7 @@ The following is a sample hashtable of all the available options you can pass wh
90101
Certificate = 'C:\cert.pfx'
91102
CertificatePassword = 's0mepa$$'
92103
}
93-
```
104+
```
94105

95106
## Install additional packages
96107

@@ -100,26 +111,31 @@ You can install additional Chocolatey packages during the installation process b
100111
To use this parameter, you must ensure that the package is available on configured sources.
101112
</Callout>
102113

103-
#### Install the latest version of the notepadplusplus.install package
114+
### Install the latest version of the notepadplusplus.install package
115+
104116
The following example installs the notepadplusplus.install package.
105117

106118
```powershell
107119
Set-Location /path/to/register-c4bendpoint.ps1
108120
. .\Register-C4bEndpoint.ps1 -RepositoryCredential (Get-Credential) -AdditionalPackages @{Id ='notepadplusplus.install'}
109121
```
110122

111-
#### Install a specific version of the notepadplusplus.install package
123+
### Install a specific version of the notepadplusplus.install package
124+
112125
The following example installs version 8.7.5 of the notepadplusplus.install package.
113126

114127
```powershell
115128
Set-Location /path/to/register-c4bendpoint.ps1
116129
. .\Register-C4bEndpoint.ps1 -RepositoryCredential (Get-Credential) -AdditionalPackages @{Id ='notepadplusplus.install'; Version = '8.7.5'}
117130
```
118131

119-
#### Install a specific version of the notepadplusplus.install package, and pin it so it does not upgrade automaticallyThe following example installs version 8.7.5 of the notepadplusplus.install package and pins it so that it is not upgraded when using `choco upgrade`
132+
### Install a specific version of the notepadplusplus.install package, and pin it so it does not upgrade automatically
133+
134+
The following example installs version 8.7.5 of the notepadplusplus.install package and pins it so that it is not upgraded when using `choco upgrade`.
135+
120136
To upgrade this package, you will need to first unpin it, and then perform the upgrade.
121137

122138
```powershell
123139
Set-Location /path/to/register-c4bendpoint.ps1
124140
. .\Register-C4bEndpoint.ps1 -RepositoryCredential (Get-Credential) -AdditionalPackages @{Id ='notepadplusplus.install'; Version = '8.7.5'; Pin = $true}
125-
```
141+
```

0 commit comments

Comments
 (0)