Skip to content

Commit ca94cc7

Browse files
committed
(doc) Highlights Windows PowerShell in Readme
1 parent 0011dfa commit ca94cc7

File tree

1 file changed

+31
-7
lines changed

1 file changed

+31
-7
lines changed

README.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,9 @@ Below are the minimum requirements for setting up your C4B server via this guide
7474
7575
### Step 1: Begin C4B Setup
7676

77-
> :exclamation:**[IMPORTANT]** All commands should be run from an **elevated** PowerShell window (and **not ISE**), by opening your PowerShell console with the `Run as Administrator` option.
77+
> :exclamation:**[IMPORTANT]** All commands must be run from an **elevated** Windows PowerShell window (and **not ISE**), by opening your PowerShell console with the `Run as Administrator` option.
7878
79-
1. Open a PowerShell console with the `Run as Administrator` option, and paste and run the following code:
79+
1. Open a Windows PowerShell console with the `Run as Administrator` option, and paste and run the following code:
8080

8181
```powershell
8282
Set-ExecutionPolicy Bypass -Scope Process -Force
@@ -96,11 +96,11 @@ Below are the minimum requirements for setting up your C4B server via this guide
9696
> </ul>
9797
> </details>
9898
99-
> :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\CCM-Files.zip`. Move the archive to your new machine, and run `Expand-Archive -Path /path/to/CCM-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.
99+
> :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.
100100
101101
### Step 2: Nexus Setup
102102
103-
1. In the same **elevated** PowerShell console as above, paste and run the following code:
103+
1. In the same **elevated** Windows PowerShell console as above, paste and run the following code:
104104
105105
```powershell
106106
Set-Location "$env:SystemDrive\choco-setup\files"
@@ -122,7 +122,7 @@ Below are the minimum requirements for setting up your C4B server via this guide
122122
> </ul>
123123
> </details>
124124
125-
### Step 3: CCM Setup
125+
### Step 3: Chocolatey Central Management Setup
126126
127127
1. In the same PowerShell Administrator console as above, paste and run the following code:
128128
@@ -136,7 +136,7 @@ Below are the minimum requirements for setting up your C4B server via this guide
136136
> <ul class="list-style-type-disc">
137137
> <li>Installs MS SQL Express and SQL Server Management Studio (SSMS)</li>
138138
> <li>Creates "ChocolateyManagement" database, and adds appropriate `ChocoUser` permissions</li>
139-
> <li>Installs all 3 CCM packages (database, service, web), with correct parameters</li>
139+
> <li>Installs all 3 Chocolatey Central Management packages (database, service, web), with correct parameters</li>
140140
> <li>Outputs data to a JSON file to pass between scripts</li>
141141
> </ul>
142142
> </details>
@@ -209,7 +209,31 @@ Below are the minimum requirements for setting up your C4B server via this guide
209209
210210
> :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.
211211
212-
### Step 6: Setting up Endpoints
212+
### Step 6: Verification
213+
214+
1. In the same **elevated** PowerShell console as above, paste and run the following code:
215+
216+
```powershell
217+
Set-Location "$env:SystemDrive\choco-setup\files"
218+
.\Start-C4bVerification.ps1 -Fqdn '<Your expected fqdn here>'
219+
```
220+
221+
If you expect services to be available at `chocoserver.yourcompany.com`, then your command would look like: `.\Start-C4bVerification.ps1 -Fqdn 'chocoserver.yourcompany.com'`
222+
223+
> <details>
224+
> <summary><strong>What does this script do? (click to expand)</strong></summary>
225+
> <ul class="list-style-type-disc">
226+
> <li>Verifies Nexus Repository installation</li>
227+
> <li>Verifies Central Management installation</li>
228+
> <li>Verifies Jenkins installation</li>
229+
> <li>Ensures system firewall is configured</li>
230+
> <li>Ensures Windows Features are installed</li>
231+
> <li>Ensures services are correctly configured</li>
232+
> <li>Ensured README is created</li>
233+
> </ul>
234+
> </details>
235+
236+
### Step 7: Setting up Endpoints
213237
214238
1. Find the `Register-C4bEndpoint.ps1` script in the `choco-setup\files\scripts\` directory on your C4B Server. Copy this script to your client endpoint.
215239

0 commit comments

Comments
 (0)