Skip to content

Commit df2af33

Browse files
committed
(docs) Adds Endpoint Configuration Doc to Readme
I found this was missing when I trued up the docs PR.
1 parent 9b2def1 commit df2af33

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ Set-Location "$env:SystemDrive\choco-setup\files"
117117
.\Initialize-C4bSetup.ps1 -Thumbprint '<YOUR_CUSTOM_SSL_CERT_THUMBPRINT_HERE>'
118118
```
119119

120-
> :warning:**REMINDER**: If you are using your own SSL certificate, be sure to place this certificate in the `Local Machine > Personal` certificate store before running the above script, and ensure that the private key is exportable.
120+
> :warning:**REMINDER**: If you are using your own SSL certificate, be sure to place this certificate in the `Local Machine > Trusted People` certificate store before running the above script, and ensure that the private key is exportable.
121121
122122
> :memo: **NOTE**
123123
> A Role and User credential will be configured to limit access to your Nexus repositories. As well, CCM Client and Service Salts are configured to further encrypt your connection between CCM and your endpoint clients. These additional settings are also incorporated into your `Register-C4bEndpoint.ps1` script for onboarding endpoints.
@@ -241,6 +241,35 @@ As a part of the C4B setup, we run tests to validate that your environment is co
241241
> </ul>
242242
> </details>
243243
244+
#### Available parameters
245+
246+
* `ClientCommunicationSalt`
247+
The salt for communication from an agent to an instance of Central Management Service. Details available in the README file on server desktop.
248+
* `ServiceCommunicationSalt`
249+
The salt for communication from an instance of Central Management Service to an agent. Details available in the README file on server desktop.
250+
* `RepositoryCredential`
251+
The credential to use to access the repository server from the endpoint. Details available in the README file on server desktop.
252+
* `ProxyUrl`
253+
The URL of a proxy server to use for connecting to the repository.
254+
* `ProxyCredential`
255+
The credentials, if required, to connect to the proxy server.
256+
* `IncludePackageTools`
257+
Install the Chocolatey Licensed Extension with right-click context menus available.
258+
* `AdditionalConfiguration`
259+
Allows for the application of user-defined configuration that is applied after the base configuration.
260+
* `AdditionalFeatures`
261+
Allows for the toggling of additional features that is applied after the base configuration.
262+
* `AdditionalPackages`
263+
Allows for the installation of additional packages after the system base packages have been installed.
264+
* `AdditionalSources`
265+
Allows for the addition of alternative sources after the base configuration has been applied.
266+
* `TrustCertificate`
267+
If passed, downloads the certificate from the client server before initializing Chocolatey Agent.
268+
269+
#### Advanced Endpoint Configuration
270+
271+
It is possible to customize the installation of Chocolatey on an endpoint via the available parameters above. For examples, please see [Advanced Endpoint Configuration](https://docs.chocolatey.org/en-us/c4b-environments/quick-start-environment/advanced-client-configuration/).
272+
244273
### Conclusion
245274
246275
Congratulations! If you followed all the steps detailed above, you should now have a fully functioning Chocolatey for Business implementation deployed in your environment.

0 commit comments

Comments
 (0)