Skip to content

Commit 95e69e5

Browse files
committed
(docs) Updates Script Names
After discussion with Ryan, this results in a more obvious flow (and use) of script names. The quicklink and docs will need to be updated.
1 parent 1bdff1b commit 95e69e5

File tree

5 files changed

+12
-13
lines changed

5 files changed

+12
-13
lines changed

Start-C4bSetup.ps1 renamed to Initialize-C4bSetup.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ $QsRepo = if ($Branch) {
121121
}
122122

123123
$DefaultEap, $ErrorActionPreference = $ErrorActionPreference, 'Stop'
124-
Start-Transcript -Path "$env:SystemDrive\choco-setup\logs\Start-C4bSetup-$(Get-Date -Format 'yyyyMMdd-HHmmss').txt"
124+
Start-Transcript -Path "$env:SystemDrive\choco-setup\logs\Initialize-C4bSetup-$(Get-Date -Format 'yyyyMMdd-HHmmss').txt"
125125

126126
try {
127127
# Setup initial choco-setup directories

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Below are the minimum requirements for setting up your C4B server via this guide
112112
113113
```powershell
114114
Set-Location "$env:SystemDrive\choco-setup\files"
115-
.\Start-C4bSetup.ps1 -Thumbprint '<YOUR_CUSTOM_SSL_CERT_THUMBPRINT_HERE>'
115+
.\Initialize-C4bSetup.ps1 -Thumbprint '<YOUR_CUSTOM_SSL_CERT_THUMBPRINT_HERE>'
116116
```
117117

118118
> :warning:**REMINDER**: If you are using your own SSL certificate, be sure to place this certificate in the `Local Machine > Personal` certificate store before running the above script, and ensure that the private key is exportable.
@@ -124,14 +124,14 @@ Set-Location "$env:SystemDrive\choco-setup\files"
124124

125125
```powershell
126126
Set-Location "$env:SystemDrive\choco-setup\files"
127-
.\Start-C4bSetup.ps1 -Thumbprint '<YOUR_CUSTOM_SSL_CERT_THUMBPRINT_HERE>' -CertificateDnsName '<YOUR_DESIRED_FQDN_HERE>'
127+
.\Initialize-C4bSetup.ps1 -Thumbprint '<YOUR_CUSTOM_SSL_CERT_THUMBPRINT_HERE>' -CertificateDnsName '<YOUR_DESIRED_FQDN_HERE>'
128128
```
129129

130130
For example, with a wildcard certificate with a thumbprint of `deee9b2fabb24bdaae71d82286e08de1` you wish to use `chocolatey.foo.org`, the following would be required:
131131

132132
```powershell
133133
Set-Location "$env:SystemDrive\choco-setup\files"
134-
.\Start-C4bSetup.ps1 -Thumbprint deee9b2fabb24bdaae71d82286e08de1 -CertificateDnsName chocolatey.foo.org
134+
.\Initialize-C4bSetup.ps1 -Thumbprint deee9b2fabb24bdaae71d82286e08de1 -CertificateDnsName chocolatey.foo.org
135135
```
136136

137137
### Step 2: Nexus Setup
@@ -221,7 +221,7 @@ Set-Location "$env:SystemDrive\choco-setup\files"
221221
222222
```powershell
223223
Set-Location "$env:SystemDrive\choco-setup\files"
224-
.\Start-C4bVerification.ps1 -Fqdn '<Your expected fqdn here>'
224+
.\Test-C4bSetup.ps1 -Fqdn '<Your expected fqdn here>'
225225
```
226226
227227
If you expect services to be available at `chocoserver.yourcompany.com`, then your command would look like: `.\Start-C4bVerification.ps1 -Fqdn 'chocoserver.yourcompany.com'`

Set-SslSecurity.ps1 renamed to Switch-SslSecurity.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ param(
6767
process {
6868
$DefaultEap = $ErrorActionPreference
6969
$ErrorActionPreference = 'Stop'
70-
Start-Transcript -Path "$env:SystemDrive\choco-setup\logs\Set-SslSecurity-$(Get-Date -Format 'yyyyMMdd-HHmmss').txt"
70+
Start-Transcript -Path "$env:SystemDrive\choco-setup\logs\Switch-SslSecurity-$(Get-Date -Format 'yyyyMMdd-HHmmss').txt"
7171

7272
# Collect current certificate configuration
7373
$Certificate = if ($Subject) {
File renamed without changes.

tests/server.tests.ps1

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,13 @@ Describe "Server Integrity" {
4545
$Logs = Get-ChildItem C:\choco-setup\logs -Recurse -Filter *.txt
4646
}
4747

48-
It "<File> log file was created during installation" -ForEach @(
49-
@{File = 'Set-SslSecurity'}
50-
@{File = 'Start-C4bCcmSetup'}
51-
@{File = 'Start-C4bJenkinsSetup'}
52-
@{File = 'Start-C4bNexusSetup'}
53-
@{File = 'Start-C4bSetup'}
48+
It "<_> log file was created during installation" -ForEach @(
49+
'Start-C4bCcmSetup'
50+
'Start-C4bJenkinsSetup'
51+
'Start-C4bNexusSetup'
52+
'Initialize-C4bSetup'
5453
) {
55-
Test-Path "C:\choco-setup\logs\$($_.File)*.txt" | Should -Be $true
54+
Test-Path "C:\choco-setup\logs\$($_)*.txt" | Should -Be $true
5655
}
5756
}
5857
}

0 commit comments

Comments
 (0)