Skip to content

Commit 3394846

Browse files
Merge pull request #1183 from JPRuskin/qsgUpdate
(doc) Updates Quickstart Guide Readme
2 parents bb7ab06 + 284e90e commit 3394846

File tree

Image for: File tree

1 file changed

Image for: 1 file changed
+29
-46
lines changed

1 file changed

Image for: 1 file changed
+29
-46
lines changed

‎src/content/docs/en-us/c4b-environments/quick-start-environment/chocolatey-for-business-quick-start-guide.mdx

Lines changed: 29 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,7 @@ export const callout3 = {
100100
- Run the following to zip up your offline bundle: `Compress-Archive -Path ~\Downloads\choco-quickstart-scripts\choco-quickstart-scripts-main\* -DestinationPath ~\Downloads\C4B-Files.zip`.
101101
- Transfer the `C4B-Files.zip` from your downloads folder to your offline system. All further steps will be carried out on the offline system.
102102
- Run `Expand-Archive -Path \path\to\C4B-Files.zip -DestinationPath C:\choco-setup\files -Force` on your offline system.
103-
- Run `Set-Location "$env:SystemDrive\choco-setup\files"; Set-ExecutionPolicy Bypass Process; .\Start-C4bSetup.ps1` on your offline system.
104-
- Proceed to Step 2!
103+
- Proceed to Certificate Options!
105104
</Callout>
106105

107106
### Step 1: Begin C4B Setup
@@ -121,33 +120,29 @@ export const callout4 = {
121120
Set-ExecutionPolicy Bypass -Scope Process -Force
122121
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::tls12
123122
Invoke-RestMethod https://ch0.co/qsg-go | Invoke-Expression
124-
Set-Location "$env:SystemDrive\choco-setup\files"
125-
.\Initialize-C4bSetup.ps1
126123
```
127124

128-
> <details>
129-
> <summary><strong>What does this script do? (click to expand)</strong></summary>
130-
> <ul class="list-style-type-disc">
131-
> <li>Installs Chocolatey client from https://community.chocolatey.org</li>
132-
> <li>Prompts for your C4B license file location, with validation</li>
133-
> <li>Converts your C4B license into a Chocolatey package</li>
134-
> <li>Configures local "choco-setup" directories</li>
135-
> <li>Downloads setup files from "choco-quickstart-scripts" GitHub repo</li>
136-
> <li>Downloads Chocolatey packages required for setup</li>
137-
> </ul>
138-
> </details>
125+
#### Certificate Options
139126

140-
<Callout content={callout3}>
141-
You can now copy the `C:\choco-setup\` directory to any computer to continue the installation. To zip up that directory, run `Compress-Archive -Path C:\choco-setup\files\* -DestinationPath C:\choco-setup\C4B-Files.zip`. Move the archive to your new machine, and run `Expand-Archive -Path /path/to/C4B-Files.zip -DestinationPath C:\choco-setup\files -Force`. You should then run `Set-Location "$env:SystemDrive\choco-setup\files"; .\Start-C4bSetup.ps1`, and continue with the guide.
142-
</Callout>
127+
**Custom SSL Certificate** - If you have your own custom SSL certificate (purchased/acquired, or from your Domain CA), you can paste and run the following script with the `Thumbprint` value of your SSL certificate specified:
128+
129+
```powershell
130+
Set-Location "$env:SystemDrive\choco-setup\files"
131+
.\Initialize-C4bSetup.ps1 -Thumbprint '<YOUR_CUSTOM_SSL_CERT_THUMBPRINT_HERE>'
132+
```
133+
134+
**Wildcard SSL Certificate** - If you have a wildcard certificate, you will also need to provide a DNS name you wish to use for that certificate:
143135

144-
#### Running with a Certificate
136+
```powershell
137+
Set-Location "$env:SystemDrive\choco-setup\files"
138+
.\Initialize-C4bSetup.ps1 -Thumbprint '<YOUR_CUSTOM_SSL_CERT_THUMBPRINT_HERE>' -CertificateDnsName '<YOUR_DESIRED_FQDN_HERE>'
139+
```
145140

146-
**ALTERNATIVE 1 : Custom SSL Certificate** - If you have your own custom SSL certificate (purchased/acquired, or from your Domain CA), you can paste and run the following script with the `Thumbprint` value of your SSL certificate specified:
141+
For example, with a wildcard certificate with a thumbprint of `deee9b2fabb24bdaae71d82286e08de1` you wish to use `chocolatey.foo.org`, the following would be required:
147142

148143
```powershell
149144
Set-Location "$env:SystemDrive\choco-setup\files"
150-
.\Initialize-C4bSetup.ps1 -Thumbprint '<YOUR_CUSTOM_SSL_CERT_THUMBPRINT_HERE>'
145+
.\Initialize-C4bSetup.ps1 -Thumbprint deee9b2fabb24bdaae71d82286e08de1 -CertificateDnsName chocolatey.foo.org
151146
```
152147

153148
<Callout type="warning">
@@ -158,19 +153,24 @@ Set-Location "$env:SystemDrive\choco-setup\files"
158153
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.
159154
</Callout>
160155

161-
**ALTERNATIVE 2 : Wildcard SSL Certificate** - If you have a wildcard certificate, you will also need to provide a DNS name you wish to use for that certificate:
156+
**Self-Signed Certificate** - If you are running a bare-minimum proof of concept environment, you can generate a self-signed certificate and use that.
162157

163158
```powershell
164159
Set-Location "$env:SystemDrive\choco-setup\files"
165-
.\Initialize-C4bSetup.ps1 -Thumbprint '<YOUR_CUSTOM_SSL_CERT_THUMBPRINT_HERE>' -CertificateDnsName '<YOUR_DESIRED_FQDN_HERE>'
160+
.\Initialize-C4bSetup.ps1
166161
```
167162

168-
For example, with a wildcard certificate with a thumbprint of `deee9b2fabb24bdaae71d82286e08de1` you wish to use `chocolatey.foo.org`, the following would be required:
169-
170-
```powershell
171-
Set-Location "$env:SystemDrive\choco-setup\files"
172-
.\Initialize-C4bSetup.ps1 -Thumbprint deee9b2fabb24bdaae71d82286e08de1 -CertificateDnsName chocolatey.foo.org
173-
```
163+
> <details>
164+
> <summary><strong>What does this script do? (click to expand)</strong></summary>
165+
> <ul class="list-style-type-disc">
166+
> <li>Installs Chocolatey client from https://community.chocolatey.org</li>
167+
> <li>Prompts for your C4B license file location, with validation</li>
168+
> <li>Converts your C4B license into a Chocolatey package</li>
169+
> <li>Configures local "choco-setup" directories</li>
170+
> <li>Downloads setup files from "choco-quickstart-scripts" GitHub repo</li>
171+
> <li>Downloads Chocolatey packages required for setup</li>
172+
> </ul>
173+
> </details>
174174
175175
#### Script: Nexus Setup
176176

@@ -236,23 +236,6 @@ As part of the C4B setup, we create a readme and install the Chocolatey Agent on
236236
A `Readme.html` file will now be generated on your desktop. This file contains login information for all 3 web portals (CCM, Nexus, and Jenkins). This `Readme.html`, along with all 3 web portals, will automatically be opened in your browser.
237237
</Callout>
238238

239-
#### Script: Verification
240-
241-
As a part of the C4B setup, we run tests to validate that your environment is correctly configured:
242-
243-
> <details>
244-
> <summary><strong>What does this script do? (click to expand)</strong></summary>
245-
> <ul class="list-style-type-disc">
246-
> <li>Verifies Nexus Repository installation</li>
247-
> <li>Verifies Central Management installation</li>
248-
> <li>Verifies Jenkins installation</li>
249-
> <li>Ensures system firewall is configured</li>
250-
> <li>Ensures Windows Features are installed</li>
251-
> <li>Ensures services are correctly configured</li>
252-
> <li>Ensured README is created</li>
253-
> </ul>
254-
> </details>
255-
256239
### Step 2: Setting up Endpoints
257240

258241
1. Find the `Register-C4bEndpoint.ps1` script in the `C:\choco-setup\files\scripts\` directory on your C4B Server. Copy this script to your client endpoint.

0 commit comments

Image for: 0 commit comments
Comments
 (0)