From e84d71e7901884c732f98fd75a78a802e1c4ebcc Mon Sep 17 00:00:00 2001 From: Stephen Valdinger Date: Tue, 7 Jan 2025 11:10:00 -0500 Subject: [PATCH] (#1117) Update client setup documentation with new parameterization options This commit adds new documentation about the parameters that are available to pass as part of registering a new endpoint into the Chocolatey solution. --- ...chocolatey-for-business-quick-start-guide.mdx | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/src/content/docs/en-us/c4b-environments/quick-start-environment/chocolatey-for-business-quick-start-guide.mdx b/src/content/docs/en-us/c4b-environments/quick-start-environment/chocolatey-for-business-quick-start-guide.mdx index 3b755eb840..8065eb7994 100644 --- a/src/content/docs/en-us/c4b-environments/quick-start-environment/chocolatey-for-business-quick-start-guide.mdx +++ b/src/content/docs/en-us/c4b-environments/quick-start-environment/chocolatey-for-business-quick-start-guide.mdx @@ -283,7 +283,7 @@ export const callout4 = { ```powershell Set-ExecutionPolicy Bypass -Scope Process -Force [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::tls12 - .\Register-C4bEndpoint.ps1 + .\Register-C4bEndpoint.ps1 -RepositoryCredential (Get-Credential) # Will prompt for username and password. Values found in README on Server Desktop. ``` >
@@ -300,6 +300,20 @@ export const callout4 = { > >
+ #### Available parameters + + * `ClientCommunicationSalt` - Chocolatey Central Management Client Communication Salt Additive - The salt additive to use in the salt recipe for encrypting and verifying communication from an agent TO an instance of Central Management Service (will need to be set the same on all clients contacting that service AND the instance of the management service itself). When not set a default encryption phrase set by the system will be used. When set the unencrypted value must match exactly with what is set in the configuration for Central Management Service and every client contacting that instance of Central Management Service. Value is not shared over the wire. Because this is a much more involved process, it is recommended only setting this if you are transmitting messages over the internet. Defaults to ''. Needs to be at least 8 characters long if set or it will throw errors and use the default. Available in business editions only. IMPORTANT: If this value is set, agents less than v0.10.0 will be unable to contact Central Management to report in. + * `ServiceCommunicationSalt` -Chocolatey Central Management Service Communication Salt Additive - The salt additive to use in the salt recipe for encrypting and verifying communication FROM an instance of Central Management Service to an agent (will need to be set the same on all clients contacting that service AND the instance of the management service itself). When not set a default encryption phrase set by the system will be used. When set the unencrypted value must match exactly with what is set in the configuration for Central Management Service and every client contacting that instance of Central Management Service. Value is not shared over the wire. Because this is a much more involved process, it is recommended only setting this if you are transmitting messages over the internet. Defaults to ''. Needs to be at least 8 characters long if set or it will throw errors and use the default. Available in business editions only. + * `RepositoryCredential` - The credential to use to access the repository server from the endpoint. Details available from README file on server desktop. + * `ProxyUrl` - The URL of a proxy server to use for connecting to the repository. + * `ProxyCredential` - The credentials, if required, to connect to the proxy server. + * `IncludePackageTools` - Install the Chocolatey Licensed Extension with right-click context menus available + * `AdditionalConfiguration` - Allows for the application of user-defined configuration that is applied after the base configuration. + * `AdditionalFeatures` - Allows for the toggling of additional features that is applied after the base configuration. + * `AdditionalPackages` - Allows for the installation of additional packages after the system base packages have been installed. + * `AdditionalSources` - Allows for the addition of alternative sources after the base configuration has been applied. + * `TrustCertificate` - If passed, downloads the certificate from the client server before initializing Chocolatey Agent + ### Conclusion Congratulations! If you followed all the steps detailed above, you should now have a fully functioning Chocolatey for Business implementation deployed in your environment.