Skip to content

Commit 1a19a24

Browse files
committed
(doc) Update Readme with Feedback
1 parent 61dcd23 commit 1a19a24

2 files changed

Lines changed: 31 additions & 43 deletions

File tree

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ To test the quickstart environment:
2222

2323
1. Copy the repository directory over to `C:\choco-setup\files\` on the test machine. You do not need to copy the `.git` directory.
2424
1. Open an elevated Windows PowerShell console.
25-
1. Run `C:\choco-setup\files\Start-C4bSetup.ps1`, and continue through the guide steps as detailed in `README.md`.
26-
1. Run `C:\choco-setup\files\Start-C4bVerification.ps1` and check that all tests pass.
25+
1. Run `C:\choco-setup\files\Initialize-C4bSetup.ps1`, and continue through the guide steps as detailed in `README.md`.
26+
1. Run `C:\choco-setup\files\Test-C4bSetup.ps1` and check that all tests pass.
2727

2828
## Testing a PR
2929

@@ -43,7 +43,7 @@ Invoke-RestMethod "https://ch0.co/qsg-go" | Invoke-Expression
4343
```
4444

4545
1. Perform each step of the Quickstart Guide, and make sure the changes you have attempted to make work appropriately.
46-
1. Run `Start-C4bVerification.ps1` and check that all tests pass.
46+
1. Run `Test-C4bSetup.ps1` and check that all tests pass.
4747
1. If everything looks OK, push your branch and create your Pull Request.
4848

4949
## Creating a PR

README.md

Lines changed: 28 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -90,39 +90,20 @@ Below are the minimum requirements for setting up your C4B server via this guide
9090
Set-ExecutionPolicy Bypass -Scope Process -Force
9191
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::tls12
9292
Invoke-RestMethod https://ch0.co/qsg-go | Invoke-Expression
93-
Set-Location "$env:SystemDrive\choco-setup\files"
94-
.\Initialize-C4bSetup.ps1
9593
```
9694
97-
> <details>
98-
> <summary><strong>What does this script do? (click to expand)</strong></summary>
99-
> <ul class="list-style-type-disc">
100-
> <li>Installs Chocolatey client from https://community.chocolatey.org</li>
101-
> <li>Prompts for your C4B license file location, with validation</li>
102-
> <li>Converts your C4B license into a Chocolatey package</li>
103-
> <li>Configures local "choco-setup" directories</li>
104-
> <li>Downloads setup files from "choco-quickstart-scripts" GitHub repo</li>
105-
> <li>Downloads Chocolatey packages required for setup</li>
106-
> </ul>
107-
> </details>
95+
> :memo:**Offline Install**: 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"; .\Initialize-C4bSetup.ps1`, and continue with the guide.
10896
109-
> :memo:**Offline Install**: 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.
97+
#### Certificate Options
11098
111-
#### Running with a Certificate
112-
113-
**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:
99+
**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:
114100
115101
```powershell
116102
Set-Location "$env:SystemDrive\choco-setup\files"
117103
.\Initialize-C4bSetup.ps1 -Thumbprint '<YOUR_CUSTOM_SSL_CERT_THUMBPRINT_HERE>'
118104
```
119105

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.
121-
122-
> :memo: **NOTE**
123-
> 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.
124-
125-
**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:
106+
**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:
126107

127108
```powershell
128109
Set-Location "$env:SystemDrive\choco-setup\files"
@@ -136,6 +117,30 @@ Set-Location "$env:SystemDrive\choco-setup\files"
136117
.\Initialize-C4bSetup.ps1 -Thumbprint deee9b2fabb24bdaae71d82286e08de1 -CertificateDnsName chocolatey.foo.org
137118
```
138119

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.
121+
122+
> :memo: **NOTE**
123+
> 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.
124+
125+
**Self-Signed Certificate** - If you are running a bare-minimum proof of concept environment, you can generate a self-signed certificate and use that.
126+
127+
```powershell
128+
Set-Location "$env:SystemDrive\choco-setup\files"
129+
.\Initialize-C4bSetup.ps1
130+
```
131+
132+
> <details>
133+
> <summary><strong>What does this script do? (click to expand)</strong></summary>
134+
> <ul class="list-style-type-disc">
135+
> <li>Installs Chocolatey client from https://community.chocolatey.org</li>
136+
> <li>Prompts for your C4B license file location, with validation</li>
137+
> <li>Converts your C4B license into a Chocolatey package</li>
138+
> <li>Configures local "choco-setup" directories</li>
139+
> <li>Downloads setup files from "choco-quickstart-scripts" GitHub repo</li>
140+
> <li>Downloads Chocolatey packages required for setup</li>
141+
> </ul>
142+
> </details>
143+
139144
#### Script: Nexus Setup
140145

141146
As part of the C4B setup, we install and configure Sonatype Nexus Repository, which is used for hosting your Chocolatey packages internally:
@@ -198,23 +203,6 @@ As part of the C4B setup, we create a readme and install the Chocolatey Agent on
198203
199204
> :mag: **FYI**: 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.
200205
201-
### Script: Verification
202-
203-
As a part of the C4B setup, we run tests to validate that your environment is correctly configured:
204-
205-
> <details>
206-
> <summary><strong>What does this script do? (click to expand)</strong></summary>
207-
> <ul class="list-style-type-disc">
208-
> <li>Verifies Nexus Repository installation</li>
209-
> <li>Verifies Central Management installation</li>
210-
> <li>Verifies Jenkins installation</li>
211-
> <li>Ensures system firewall is configured</li>
212-
> <li>Ensures Windows Features are installed</li>
213-
> <li>Ensures services are correctly configured</li>
214-
> <li>Ensured README is created</li>
215-
> </ul>
216-
> </details>
217-
218206
### Step 2: Setting up Endpoints
219207

220208
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

Comments
 (0)