Skip to content

Commit 05865e1

Browse files
committed
(doc) Updates Phrasing on Azure ClientSetup
Customers were being confused by the reference to the ClientSetup script. This commit attempts to reduce confusion, and also converts the script to the new DynamicCodeBlock.
1 parent 4ea2d17 commit 05865e1

File tree

1 file changed

+22
-16
lines changed

1 file changed

+22
-16
lines changed

src/content/docs/en-us/c4b-environments/azure/client-setup.mdx

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ description: How to setup a client machine to use Chocolatey for Business Azure
77
import Callout from '@choco-astro/components/Callout.astro';
88
import Iframe from '@choco-astro/components/Iframe.astro';
99
import Xref from '@components/Xref.astro';
10+
import DynamicCodeBlockInput from '@choco-astro/components/dynamicCodeBlock/DynamicCodeBlockInput.astro';
11+
import DynamicCodeBlock from '@choco-astro/components/dynamicCodeBlock/DynamicCodeBlock.astro';
1012

1113
## Summary
1214

@@ -51,46 +53,49 @@ If you used a self-signed certificate to deploy your Chocolatey for Business Azu
5153
1. Click **Next**, **Next**, then **Finish**
5254
1. Close the Microsoft Management Console
5355

54-
## Client Setup Script
56+
## Endpoint Registration
5557

56-
To on-board clients, you run the `ClientSetup.ps1` script provided with your Chocolatey for Business Azure Environment.
58+
To on-board clients, you can run the following script, which will download all requirements from your environment and configure it with our suggested defaults.
5759

58-
You will need the following values ready when running this script:
60+
<Callout type="info">
61+
Updating the values here will update the script below - no values are sent to a server, they are temporarily stored locally in your browser.
62+
</Callout>
63+
64+
You will require the following values to run this script:
5965

6066
* `FQDN`: The fully qualified domain name used to access your environment.
67+
<DynamicCodeBlockInput name="AzureFqdnValue" defaultValue="Enter the FQDN for your Chocolatey for Business Azure Environment here..." />
6168
* `ccmClientCommunicationSalt`: This is the client-side salt additive. More information about this can be found in the <Xref title="C4B Config Settings" value="ccm-client" anchor="config-settings" /> docs.
69+
<DynamicCodeBlockInput name="AzureCcmClientSaltValue" defaultValue="Enter your ccmClientCommunicationSalt here..." />
6270
* `ccmServiceCommunicationSalt`: This is the server-side salt additive. More information about this can be found in the <Xref title="C4B Config Settings" value="ccm-client" anchor="config-settings" /> docs.
71+
<DynamicCodeBlockInput name="AzureCcmServiceSaltValue" defaultValue="Enter your ccmServiceCommunicationSalt here..." />
6372
* `ChocoUserPassword`: The password for the `chocouser` account which is used by the client to access your environments' Sonatype Nexus Repository service.
73+
<DynamicCodeBlockInput name="AzureChocoUserPasswordValue" defaultValue="Enter your ChocoUserPassword here..." />
6474

6575
Except for the `FQDN`, all of these values are available in your deployed environment's Azure Key Vault.
6676
See <Xref title="Accessing Services" value="c4b-azure" anchor="accessing-services" /> for more information about retrieving values from the Vault.
6777

68-
When you're ready, run the following on the client from an elevated (Run as Administrator) PowerShell session:
78+
When you're ready, save the following script to the target client (e.g. as `Register-C4bEndpoint.ps1`) and run it from an elevated (Run as Administrator) PowerShell session (e.g. `~\path\to\Register-C4bEndpoint.ps1`):
6979

70-
```powershell
80+
<DynamicCodeBlock language="powershell">
81+
{`
7182
[CmdletBinding(HelpUri = 'https://docs.chocolatey.org/en-us/c4b-environments/quick-start-environment/advanced-client-configuration/')]
7283
param(
7384
# The DNS name of the server that hosts your repository, Jenkins, and Chocolatey Central Management
74-
[String]$Fqdn = '{{ Replace with the FQDN for your Chocolatey for Business Azure Environment }}',
85+
[String]$Fqdn = 'AzureFqdnValue',
7586
7687
# Client salt value used to populate the centralManagementClientCommunicationSaltAdditivePassword value in the Chocolatey config file
77-
[String]$ClientCommunicationSalt = '{{ Replace with ccmClientCommunicationSalt (This value is in your Azure KeyVault) }}',
88+
[String]$ClientCommunicationSalt = 'AzureCcmClientSaltValue',
7889
7990
# Server salt value used to populate the centralManagementServiceCommunicationSaltAdditivePassword value in the Chocolatey config file
80-
[String]$ServiceCommunicationSalt = '{{ Replace with ccmServiceCommunicationSalt (This value is in your Azure KeyVault) }}',
91+
[String]$ServiceCommunicationSalt = 'AzureCcmServiceSaltValue',
8192
8293
# The credential for accessing your Nexus repository, e.g. for 'chocouser'
8394
$RepositoryCredential = [System.Net.NetworkCredential]@{
8495
'userName' = 'chocouser'
85-
'password' = '{{ Replace with ChocoUserPassword (This value is in your Azure KeyVault) }}'
96+
'password' = 'AzureChocoUserPasswordValue'
8697
},
8798
88-
# The URL of a proxy server to use for connecting to the repository.
89-
[String]$ProxyUrl,
90-
91-
# The credentials, if required, to connect to the proxy server.
92-
[PSCredential]$ProxyCredential,
93-
9499
# Install the Chocolatey Licensed Extension with right-click context menus available
95100
[Switch]$IncludePackageTools,
96101
@@ -122,7 +127,8 @@ $downloader.Credentials = $RepositoryCredential
122127
$script = $downloader.DownloadString("https://$($FQDN)/nexus/repository/choco-install/ClientSetup.ps1")
123128
124129
& ([scriptblock]::Create($script)) @params
125-
```
130+
`}
131+
</DynamicCodeBlock>
126132

127133
This script will accomplish the following on your client:
128134

0 commit comments

Comments
 (0)