From dd0ff352b515abf1b648c0a629bbc50a08a0aac4 Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Fri, 20 Oct 2023 14:48:09 +0100 Subject: [PATCH 01/21] Separated Single Server App Server install into sections and applied to these pages --- .../apply-recommended-security-measures.md | 36 +++ .../install-dot-net-framework.md | 17 ++ .../make-installation-artefacts-available.md | 6 + .../check-application-services.md} | 0 .../single-server/add-antivirus-exclusions.md | 18 ++ .../configure-installation-script.md | 75 +++++ .../configure-installation-script.md | 75 +++++ .../add-permissions-to-crypto-folder.md | 14 + .../check-application-services.md} | 0 .../single-server/check-port-useage.md | 23 ++ .../single-server/run-installation-script.md | 31 +++ .../single-server/test-installation-script.md | 31 +++ .../_shared/preserve-installation-files.md | 1 + ...ll-application-and-loadbalancer-servers.md | 2 +- .../install-application-server.md | 254 +---------------- ...ll-application-and-loadbalancer-servers.md | 2 +- .../install-application-server.md | 261 +----------------- 17 files changed, 355 insertions(+), 491 deletions(-) create mode 100644 content/en/docs/2023.11/_shared/install-application-server/apply-recommended-security-measures.md create mode 100644 content/en/docs/2023.11/_shared/install-application-server/install-dot-net-framework.md create mode 100644 content/en/docs/2023.11/_shared/install-application-server/make-installation-artefacts-available.md rename content/en/docs/2023.11/_shared/install-application-server/{check-application-services/multi-server.md => multi-server/check-application-services.md} (100%) create mode 100644 content/en/docs/2023.11/_shared/install-application-server/single-server/add-antivirus-exclusions.md create mode 100644 content/en/docs/2023.11/_shared/install-application-server/single-server/add-innovation-only/configure-installation-script.md create mode 100644 content/en/docs/2023.11/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md create mode 100644 content/en/docs/2023.11/_shared/install-application-server/single-server/add-permissions-to-crypto-folder.md rename content/en/docs/2023.11/_shared/install-application-server/{check-application-services/single-server.md => single-server/check-application-services.md} (100%) create mode 100644 content/en/docs/2023.11/_shared/install-application-server/single-server/check-port-useage.md create mode 100644 content/en/docs/2023.11/_shared/install-application-server/single-server/run-installation-script.md create mode 100644 content/en/docs/2023.11/_shared/install-application-server/single-server/test-installation-script.md create mode 100644 content/en/docs/2023.11/_shared/preserve-installation-files.md diff --git a/content/en/docs/2023.11/_shared/install-application-server/apply-recommended-security-measures.md b/content/en/docs/2023.11/_shared/install-application-server/apply-recommended-security-measures.md new file mode 100644 index 000000000..045b8aea6 --- /dev/null +++ b/content/en/docs/2023.11/_shared/install-application-server/apply-recommended-security-measures.md @@ -0,0 +1,36 @@ +These are non-compulsory security measures, recommended to be applied to the server, in order to prevent potential attacks that exploit known industry security vulnerabilities. + +Applying these measures may impact other applications running on your server. Therefore, it is your responsibility to ensure that other applications and their clients will not be affected by the changes. + +### Only Use Recommended Encryption Algorithms and TLS Protocols + +A collection of registry settings need to be applied to guarantee your server is only using the recommended encryption algorithms and TLS protocols. Information about these settings can be found at [SSL Best Practices][]. + +{{% alert type="warning" title="Warning" %}}Disabling specific TLS versions or specific Cipher Suites can have impact on {{% ctx %}} components themselves as well as their communication capabilities with third party systems and services, e.g. Execution Service executing flows with blocks which communicate with 3rd parties via PowerShell or REST. All parties communicating together must support a shared protocol version and cipher suite, otherwise they will not be able to establish a secure communication link between each other.{{% /alert %}} + +The settings can be applied by running a script. Be aware that the server will be restarted when the script is run. Apply the settings by following these instructions: + +1. Open a Windows PowerShell (x64) window as administrator. +1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: + + ```powershell + cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" + ``` + +1. Run the `Cortex.Innovation.Install.SSLBestPractices.ps1` script using the following command: + + ```powershell + .\Cortex.Innovation.Install.SSLBestPractices.ps1 + ``` + + {{% alert title="Note" %}} +To avoid answering all of the prompts `-Override 0` can be added to the end of the script. This will automatically apply all settings and forcibly restart the server. + {{% /alert %}} + + If `-Override 0` has been specified no further steps need to be taken and you can move on to the next section when the server has restarted. +1. To use all the recommended settings click `Apply all` to the first prompt. + + To selectively apply each setting select `Choose which to apply`. Each change will then be prompted with a Yes/No confirmation before applying. +1. Restart the machine when the script asks. + +[SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} \ No newline at end of file diff --git a/content/en/docs/2023.11/_shared/install-application-server/install-dot-net-framework.md b/content/en/docs/2023.11/_shared/install-application-server/install-dot-net-framework.md new file mode 100644 index 000000000..30964ad61 --- /dev/null +++ b/content/en/docs/2023.11/_shared/install-application-server/install-dot-net-framework.md @@ -0,0 +1,17 @@ +Microsoft Service Fabric requires a minimum of Microsoft .NET Framework 4.7.2 to be installed on the server. + +To find the version of the framework that is installed: + +1. On the Start menu, choose `Run`. +1. In the open box, enter `regedit.exe`. You must have administrative credentials to run regedit.exe. +1. In the Registry Editor, open the subkey `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\NET Framework Setup\NDP\v4\Full`. +1. If the `Full` subkey is not present, then you do not have the .NET Framework 4.5 or later installed. +1. Check for a `DWORD` value named `Release`. The existence of the Release DWORD indicates the .NET Framework 4.5 or newer has been installed on that computer. If the value is `461808` or over then at least .NET Framework 4.7.2 is installed and no further steps need to be taken. If it is not installed, continue with the following steps to install it. + +To install .NET Framework 4.7.2: + +1. Download the [.NET Framework 4.7.2][NET Framework 472] installer. +1. Double-click on the installer file to run it. +1. Follow the wizard to complete the installation. + +[NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}} diff --git a/content/en/docs/2023.11/_shared/install-application-server/make-installation-artefacts-available.md b/content/en/docs/2023.11/_shared/install-application-server/make-installation-artefacts-available.md new file mode 100644 index 000000000..4371a34ad --- /dev/null +++ b/content/en/docs/2023.11/_shared/install-application-server/make-installation-artefacts-available.md @@ -0,0 +1,6 @@ +1. Copy the following artefacts to a folder on the server: + * Cortex Innovation {{< version >}} - Block Packages.zip + * Cortex Innovation {{< version >}} - App Services.zip + * Cortex Innovation {{< version >}} - App Server Install Scripts.zip + +1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. diff --git a/content/en/docs/2023.11/_shared/install-application-server/check-application-services/multi-server.md b/content/en/docs/2023.11/_shared/install-application-server/multi-server/check-application-services.md similarity index 100% rename from content/en/docs/2023.11/_shared/install-application-server/check-application-services/multi-server.md rename to content/en/docs/2023.11/_shared/install-application-server/multi-server/check-application-services.md diff --git a/content/en/docs/2023.11/_shared/install-application-server/single-server/add-antivirus-exclusions.md b/content/en/docs/2023.11/_shared/install-application-server/single-server/add-antivirus-exclusions.md new file mode 100644 index 000000000..0fa01386f --- /dev/null +++ b/content/en/docs/2023.11/_shared/install-application-server/single-server/add-antivirus-exclusions.md @@ -0,0 +1,18 @@ +1. If Windows Defender is not running on the server, ensure that the [Antivirus Exclusions][] have been added to the running antivirus software on the server and continue to the next section, otherwise follow these steps: + 1. Open a Windows PowerShell (x64) window as administrator. + 1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: + + ```powershell + cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" + ``` + + 1. Run the `Cortex.Innovation.Add.WindowsDefenderExclusions.ps1` script using the following command, modifying the `ApplicationServers` value to contain the NETBIOS name or fully qualified domain name of the server: + + ```powershell + .\Cortex.Innovation.Add.WindowsDefenderExclusions.ps1 -ApplicationServers @("app-server1") + ``` + + 1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK. + 1. A message will indicate that the script has completed successfully. + +[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.AntivirusExclusions" >}} \ No newline at end of file diff --git a/content/en/docs/2023.11/_shared/install-application-server/single-server/add-innovation-only/configure-installation-script.md b/content/en/docs/2023.11/_shared/install-application-server/single-server/add-innovation-only/configure-installation-script.md new file mode 100644 index 000000000..0cfe56850 --- /dev/null +++ b/content/en/docs/2023.11/_shared/install-application-server/single-server/add-innovation-only/configure-installation-script.md @@ -0,0 +1,75 @@ +1. In the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder, locate the `Cortex.Innovation.Install.ps1` script and open it with a text editor. +1. Choose the tab below that matches the configuration for this installation, then update the script to match, changing the parameters according to the details given below: + + {{< tabpane lang="powershell" >}} + {{< tab header="CA Certs" >}} +.\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` + -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` + -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` + -ApiGatewayBasicAuthUsername "BasicAuthUser" ` + -ApiGatewayBasicAuthPassword "ADA9883B11BD4CDC908B8131B57944A4" ` + -CustomerName "Customer1" ` + -ApplicationServerIPv4Addresses @("192.168.1.1") ` + -ServerCertificatePath "C:\Install\Certificates\cert.pfx" ` + -ServerCertificatePassword "myPassword" ` + -SkipLoadBalancer ` + -Credential $Credential ` + -LdapConnectionDetails @{ + Host= "LDAP://ldapserver.fqdn.com:389" + UseSsl= $false + Username= "someUserName" + Password= "somePassword" + } ` + -AcceptEULA:$AcceptEula ` + *>&1 | Tee-Object -FilePath "cortex-app-install-log.txt" + {{< /tab >}} + {{< tab header="Self-Signed Certs" >}} +.\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` + -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` + -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` + -ApiGatewayBasicAuthUsername "BasicAuthUser" ` + -ApiGatewayBasicAuthPassword "ADA9883B11BD4CDC908B8131B57944A4" ` + -CustomerName "Customer1" ` + -ApplicationServerIPv4Addresses @("192.168.1.1") ` + -UseSelfSignedCertificates ` + -SkipLoadBalancer ` + -Credential $Credential ` + -LdapConnectionDetails @{ + Host= "LDAP://ldapserver.fqdn.com:389" + UseSsl= $false + Username= "someUserName" + Password= "somePassword" + } ` + -AcceptEULA:$AcceptEula ` + *>&1 | Tee-Object -FilePath "cortex-app-install-log.txt" + {{< /tab >}} + {{< /tabpane >}} + + | Name | Description | + |----------------------------------------------|-------------| + |`AppServicesPath` | Configure this value with the location of the App Services zip file on the server. | + |`BlockPackagesPath` | Configure this value with the location of the Block Packages zip file on the server. | + |`ApiGatewayBasicAuthUsername` | Configure this value with a username that can be used to make HTTPS requests to the API Gateway Service using Basic Authentication (e.g. starting flows). This username will be used by Gateway for all HTTPS requests to the API Gateway Service.

For security reasons it is recommended that the default value `BasicAuthUser` should be changed.

This value will be needed [later, when installing Gateway][Install Gateway].

This username can also be used by external services for HTTPS requests to the API Gateway Service but is not recommended; these requests should use an OAuth2 session for an authorised Active Directory user.| + |`ApiGatewayBasicAuthPassword` | Configure this value with the password for the username specified for `ApiGatewayBasicAuthUsername`.

This password should be [{{% ctx %}} Encrypted][CORTEX Encrypted]. For security reasons it is recommended that the default value `ADA9883B11BD4CDC908B8131B57944A4` should be changed.

This value will be needed [later, when installing Gateway][Install Gateway].| + |`CustomerName` | A name identifying the platform being installed. This must have no spaces or symbols. It will be appended to the node names that are displayed in Service Fabric Explorer. | + |`ApplicationServerIPv4Addresses` | The IPv4 address of the server.| + |`ServerCertificatePath` | The local path of a .PFX certificate file on the server. Environment variables cannot be used.

This is only needed if installing with CA Certificates (Recommended). The certificate should meet the [Certificate Requirements][].

This certificate will be used for: {{< alert type="warning" title="Warning" >}}It is critical to set a reminder to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.RolloverCertificates" title="update certificates" >}} in good time before they expire. If they expire then the platform will cease to function and {{< ahref path="Cortex.ServicePortal.MainDoc" title="CORTEX Service Portal" >}} must be contacted for support.{{< /alert >}}| + |`ServerCertificatePassword` | The password for the .PFX certificate file specified in `ServerCertificatePath`.

This is only needed if installing with CA Certificates (Recommended).| + |`UseSelfSignedCertificates` | Installs Application Services and required infrastructure using generated Self-Signed Certificates rather than CA Certificates.

Not recommended for production use. | + |`SkipLoadBalancer` | Installs Application Services and required infrastructure without installing a load balancer. | + |`Credential` | The credentials of the user which will be used to perform remote operations on the server. It must be a domain user that is a member of the local Administrators group on the server.

This does not need to be changed, a prompt will appear to enter this information when the script is run. | + |`LdapConnectionDetails` | The connection details to the LDAP server.

This must be configured with a valid `Host`, `Username`, `Password`, and whether the LDAP server uses SSL using `UseSsl`. {{< alert type="note" title="Note" >}}All fields but `UseSsl` can be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | + |`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. | + |`FilePath` | The filename that installation logs are written to. If this should be written to a different location than where the installation files are then a full path should be specified. | + + The `ApiGatewayBasicAuthUsername` and `ApiGatewayBasicAuthPassword` will be needed [later, when installing Gateway][Install Gateway]. + + {{% alert title="Note" %}} +More advanced configuration (such as changing ports) can be undertaken by modifying the `Cortex.Innovation.Install.Config.json` file but this shouldn't be required for most installations. More information about this can be found at {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.AdvancedConfigSingleServer" title="Advanced Application Server and Load Balancer Configuration Changes" >}}. + {{% /alert %}} + +1. Save and close `Cortex.Innovation.Install.ps1`. + +[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.CertificateRequirements" >}} +[CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} +[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScript" >}} \ No newline at end of file diff --git a/content/en/docs/2023.11/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md b/content/en/docs/2023.11/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md new file mode 100644 index 000000000..2a1b576e5 --- /dev/null +++ b/content/en/docs/2023.11/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md @@ -0,0 +1,75 @@ +1. In the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder, locate the `Cortex.Innovation.Install.ps1` script and open it with a text editor. +1. Choose the tab below that matches the configuration for this installation, then update the script to match, changing the parameters according to the details given below: + + {{< tabpane lang="powershell" >}} + {{< tab header="CA Certs" >}} +.\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` + -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` + -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` + -ApiGatewayBasicAuthUsername "BasicAuthUser" ` + -ApiGatewayBasicAuthPassword "ADA9883B11BD4CDC908B8131B57944A4" ` + -CustomerName "Customer1" ` + -ApplicationServerIPv4Addresses @("192.168.1.1") ` + -ServerCertificatePath "C:\Install\Certificates\cert.pfx" ` + -ServerCertificatePassword "myPassword" ` + -SkipLoadBalancer ` + -Credential $Credential ` + -LdapConnectionDetails @{ + Host= "LDAP://ldapserver.fqdn.com:389" + UseSsl= $false + Username= "someUserName" + Password= "somePassword" + } ` + -AcceptEULA:$AcceptEula ` + *>&1 | Tee-Object -FilePath "cortex-app-install-log.txt" + {{< /tab >}} + {{< tab header="Self-Signed Certs" >}} +.\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` + -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` + -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` + -ApiGatewayBasicAuthUsername "BasicAuthUser" ` + -ApiGatewayBasicAuthPassword "ADA9883B11BD4CDC908B8131B57944A4" ` + -CustomerName "Customer1" ` + -ApplicationServerIPv4Addresses @("192.168.1.1") ` + -UseSelfSignedCertificates ` + -SkipLoadBalancer ` + -Credential $Credential ` + -LdapConnectionDetails @{ + Host= "LDAP://ldapserver.fqdn.com:389" + UseSsl= $false + Username= "someUserName" + Password= "somePassword" + } ` + -AcceptEULA:$AcceptEula ` + *>&1 | Tee-Object -FilePath "cortex-app-install-log.txt" + {{< /tab >}} + {{< /tabpane >}} + + | Name | Description | + |----------------------------------------------|-------------| + |`AppServicesPath` | Configure this value with the location of the App Services zip file on the server. | + |`BlockPackagesPath` | Configure this value with the location of the Block Packages zip file on the server. | + |`ApiGatewayBasicAuthUsername` | Configure this value with a username that can be used to make HTTPS requests to the API Gateway Service using Basic Authentication (e.g. starting flows). This username will be used by Gateway for all HTTPS requests to the API Gateway Service.

For security reasons it is recommended that the default value `BasicAuthUser` should be changed.

This value will be needed [later, when upgrading Gateway][Upgrade Gateway].

This username can also be used by external services for HTTPS requests to the API Gateway Service but is not recommended; these requests should use an OAuth2 session for an authorised Active Directory user.| + |`ApiGatewayBasicAuthPassword` | Configure this value with the password for the username specified for `ApiGatewayBasicAuthUsername`.

This password should be [{{% ctx %}} Encrypted][CORTEX Encrypted]. For security reasons it is recommended that the default value `ADA9883B11BD4CDC908B8131B57944A4` should be changed.

This value will be needed [later, when upgrading Gateway][Upgrade Gateway].| + |`CustomerName` | A name identifying the platform being installed. This must have no spaces or symbols. It will be appended to the node names that are displayed in Service Fabric Explorer. | + |`ApplicationServerIPv4Addresses` | The IPv4 address of the server.| + |`ServerCertificatePath` | The local path of a .PFX certificate file on the server. Environment variables cannot be used.

This is only needed if installing with CA Certificates (Recommended). The certificate should meet the [Certificate Requirements][].

This certificate will be used for: {{< alert type="warning" title="Warning" >}}It is critical to set a reminder to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.RolloverCertificates" title="update certificates" >}} in good time before they expire. If they expire then the platform will cease to function and {{< ahref path="Cortex.ServicePortal.MainDoc" title="CORTEX Service Portal" >}} must be contacted for support.{{< /alert >}}| + |`ServerCertificatePassword` | The password for the .PFX certificate file specified in `ServerCertificatePath`.

This is only needed if installing with CA Certificates (Recommended).| + |`UseSelfSignedCertificates` | Installs Application Services and required infrastructure using generated Self-Signed Certificates rather than CA Certificates.

Not recommended for production use. | + |`SkipLoadBalancer` | Installs Application Services and required infrastructure without installing a load balancer. | + |`Credential` | The credentials of the user which will be used to perform remote operations on the server. It must be a domain user that is a member of the local Administrators group on the server.

This does not need to be changed, a prompt will appear to enter this information when the script is run. | + |`LdapConnectionDetails` | The connection details to the LDAP server.

This must be configured with a valid `Host`, `Username`, `Password`, and whether the LDAP server uses SSL using `UseSsl`. {{< alert type="note" title="Note" >}}All fields but `UseSsl` can be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | + |`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. | + |`FilePath` | The filename that installation logs are written to. If this should be written to a different location than where the installation files are then a full path should be specified. | + + The `ApiGatewayBasicAuthUsername` and `ApiGatewayBasicAuthPassword` will be needed [later, when upgrading Gateway][Upgrade Gateway]. + + {{% alert title="Note" %}} +More advanced configuration (such as changing ports) can be undertaken by modifying the `Cortex.Innovation.Install.Config.json` file but this shouldn't be required for most installations. More information about this can be found at {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.AdvancedConfigSingleServer" title="Advanced Application Server and Load Balancer Configuration Changes" >}}. + {{% /alert %}} + +1. Save and close `Cortex.Innovation.Install.ps1`. + +[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.CertificateRequirements" >}} +[CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} +[Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScript" >}} \ No newline at end of file diff --git a/content/en/docs/2023.11/_shared/install-application-server/single-server/add-permissions-to-crypto-folder.md b/content/en/docs/2023.11/_shared/install-application-server/single-server/add-permissions-to-crypto-folder.md new file mode 100644 index 000000000..039984369 --- /dev/null +++ b/content/en/docs/2023.11/_shared/install-application-server/single-server/add-permissions-to-crypto-folder.md @@ -0,0 +1,14 @@ +Service Fabric requires access to the `C:\ProgramData\Microsoft\Crypto\` folder for the `Network Service` users. + +Grant access to the `Network Service` user following these instructions: + +1. Open a Windows PowerShell (x64) window as administrator. +1. Run the following command: + +```bash +icacls "C:\ProgramData\Microsoft\Crypto\*" /grant *S-1-5-20:RX /t +``` + +{{% alert title="Note" %}} +Some files might fail to be processed with `Access is denied`. This can be ignored. +{{% /alert %}} diff --git a/content/en/docs/2023.11/_shared/install-application-server/check-application-services/single-server.md b/content/en/docs/2023.11/_shared/install-application-server/single-server/check-application-services.md similarity index 100% rename from content/en/docs/2023.11/_shared/install-application-server/check-application-services/single-server.md rename to content/en/docs/2023.11/_shared/install-application-server/single-server/check-application-services.md diff --git a/content/en/docs/2023.11/_shared/install-application-server/single-server/check-port-useage.md b/content/en/docs/2023.11/_shared/install-application-server/single-server/check-port-useage.md new file mode 100644 index 000000000..b3f7447f8 --- /dev/null +++ b/content/en/docs/2023.11/_shared/install-application-server/single-server/check-port-useage.md @@ -0,0 +1,23 @@ +1. To check all necessary ports are free, follow these steps. + 1. Open a Windows PowerShell (x64) window as administrator. + 1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: + + ```powershell + cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" + ``` + + 1. Run the `Cortex.Innovation.Test.PortUsage.ps1` script using the following command, modifying the `ApplicationServers` value to contain the NETBIOS name or fully qualified domain name of the server: + + ```powershell + .\Cortex.Innovation.Test.PortUsage.ps1 -ApplicationServers @("app-server1") + ``` + + 1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK. + + 1. If all ports are free, the script will report the following: + + `All ports required by Cortex Innovation are free` + + If this is the case, continue to the next section. Otherwise, consult the messages returned by the script, which will give details about how to modify the `Cortex.Innovation.Install.Config.json` configuration file, in the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder, to use different ports. This will be used later during installation. + + The `Cortex.Innovation.Test.PortUsage.ps1` script cannot currently re-check modified ports in the configuration file so these need to be manually checked to see that they are free. diff --git a/content/en/docs/2023.11/_shared/install-application-server/single-server/run-installation-script.md b/content/en/docs/2023.11/_shared/install-application-server/single-server/run-installation-script.md new file mode 100644 index 000000000..b698abff0 --- /dev/null +++ b/content/en/docs/2023.11/_shared/install-application-server/single-server/run-installation-script.md @@ -0,0 +1,31 @@ +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.Install.ps1 + ``` + +1. Please read the End User Licence Agreement which can be found [here][Eula]. Once you agree to the terms, add the flag `-AcceptEULA` to the command entered above, e.g: + + ```powershell + .\.ps1 -AcceptEULA + ``` + +1. Run the PowerShell command to install HA Services and the required infrastructure. +1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK. +1. A password prompt will appear. Enter a password which will be used to create a user in RabbitMQ. This should be entered carefully and recorded as it may be needed if seeking support from [{{% ctx %}} Service Portal][CORTEX Service Portal]. Press OK. +1. Wait for the script to finish running. This should take approximately 10 minutes. +1. Check that there have been no errors in the script; these would appear in red in the console. + + If there are any errors, then please follow any instructions given within them to rectify the situation, check your configuration files, and retry the installation. + + In some circumstances, retrying may error due to components being installed already. In this case please run the following command, followed by the original installation command: + + ```powershell + .\Cortex.Innovation.Uninstall.ps1 -SkipLoadBalancer + ``` + + If the errors do not give any instructions on how to rectify, see [Troubleshooting During Installation][] for further information; if this does not help then please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for assistance. + +[Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} +[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} +[Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} \ No newline at end of file diff --git a/content/en/docs/2023.11/_shared/install-application-server/single-server/test-installation-script.md b/content/en/docs/2023.11/_shared/install-application-server/single-server/test-installation-script.md new file mode 100644 index 000000000..36ae69a3a --- /dev/null +++ b/content/en/docs/2023.11/_shared/install-application-server/single-server/test-installation-script.md @@ -0,0 +1,31 @@ +1. Open a Windows PowerShell (x64) window as administrator. +1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: + + ```powershell + cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.Install.ps1 -WhatIf + ``` + +1. Please read the End User Licence Agreement which can be found [here][Eula]. Once you agree to the terms, add the flag `-AcceptEULA` to the command entered above, e.g: + + ```powershell + .\.ps1 -WhatIf -AcceptEULA + ``` + +1. Run the PowerShell command to test the installation script. +1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK. +1. A password prompt will appear. Enter a password which will be used to create a user in RabbitMQ. +1. Wait for the command to finish. It will display the output of the installation command without making any changes to the system. +1. Check that there have been no errors in the script; these would appear in red in the console. + + If there are no errors, continue to the next section; otherwise, check if the errors have any instructions for rectifying the issue and follow them. + + If there are no useful instructions, check that all previous steps have been followed correctly and, if not, rectify it and run the command again.

If this does not work, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for further assistance. The `WhatIf` script will have created a temporary version of the config file in the script location, showing what changes would be made to it when the script runs. The name is appended with `-WhatIf` (e.g. `Cortex.Innovation.Install.Config-WhatIf.json`). This file can be provided when obtaining support. + +[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} +[Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} \ No newline at end of file diff --git a/content/en/docs/2023.11/_shared/preserve-installation-files.md b/content/en/docs/2023.11/_shared/preserve-installation-files.md new file mode 100644 index 000000000..6e485d456 --- /dev/null +++ b/content/en/docs/2023.11/_shared/preserve-installation-files.md @@ -0,0 +1 @@ +Ensure that the installation files are backed up or kept on the server, especially the scripts and config files that have been modified. This will make it easier to perform further actions in future, such as troubleshooting, certificate rollover, uninstallation, reinstallation and updates. \ No newline at end of file diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md index 4934eda0f..138c50fe9 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md @@ -304,7 +304,7 @@ More advanced configuration (such as changing ports) can be undertaken by modify ## Check Application Services -{{< section "/install-application-server/check-application-services/multi-server.md">}} +{{< section "/install-application-server/multi-server/check-application-services.md">}} ## Preserve installation files diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md index 8a8aa6fb0..557eb3f8f 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md @@ -11,247 +11,35 @@ This guide describes how to install the Application Server components on the ser ## Make Installation Artefacts Available -1. Copy the following artefacts to a folder on the server: - * Cortex Innovation {{< version >}} - Block Packages.zip - * Cortex Innovation {{< version >}} - App Services.zip - * Cortex Innovation {{< version >}} - App Server Install Scripts.zip - -1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. +{{< section "/install-application-server/make-installation-artefacts-available.md">}} ## Install Microsoft .NET Framework 4.7.2 -Microsoft Service Fabric requires a minimum of Microsoft .NET Framework 4.7.2 to be installed on the server. - -To find the version of the framework that is installed: - -1. On the Start menu, choose `Run`. -1. In the open box, enter `regedit.exe`. You must have administrative credentials to run regedit.exe. -1. In the Registry Editor, open the subkey `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\NET Framework Setup\NDP\v4\Full`. -1. If the `Full` subkey is not present, then you do not have the .NET Framework 4.5 or later installed. -1. Check for a `DWORD` value named `Release`. The existence of the Release DWORD indicates the .NET Framework 4.5 or newer has been installed on that computer. If the value is `461808` or over then at least .NET Framework 4.7.2 is installed and no further steps need to be taken. If it is not installed, continue with the following steps to install it. - -To install .NET Framework 4.7.2: - -1. Download the [.NET Framework 4.7.2][NET Framework 472] installer. -1. Double-click on the installer file to run it. -1. Follow the wizard to complete the installation. +{{< section "/install-application-server/install-dot-net-framework.md">}} ## Apply Recommended Security Measures -These are non-compulsory security measures, recommended to be applied to the server, in order to prevent potential attacks that exploit known industry security vulnerabilities. - -Applying these measures may impact other applications running on your server. Therefore, it is your responsibility to ensure that other applications and their clients will not be affected by the changes. - -### Only Use Recommended Encryption Algorithms and TLS Protocols - -A collection of registry settings need to be applied to guarantee your server is only using the recommended encryption algorithms and TLS protocols. Information about these settings can be found at [SSL Best Practices][]. - -{{% alert type="warning" title="Warning" %}}Disabling specific TLS versions or specific Cipher Suites can have impact on {{% ctx %}} components themselves as well as their communication capabilities with third party systems and services, e.g. Execution Service executing flows with blocks which communicate with 3rd parties via PowerShell or REST. All parties communicating together must support a shared protocol version and cipher suite, otherwise they will not be able to establish a secure communication link between each other.{{% /alert %}} - -The settings can be applied by running a script. Be aware that the server will be restarted when the script is run. Apply the settings by following these instructions: - -1. Open a Windows PowerShell (x64) window as administrator. -1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: - - ```powershell - cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" - ``` - -1. Run the `Cortex.Innovation.Install.SSLBestPractices.ps1` script using the following command: - - ```powershell - .\Cortex.Innovation.Install.SSLBestPractices.ps1 - ``` - - {{% alert title="Note" %}} -To avoid answering all of the prompts `-Override 0` can be added to the end of the script. This will automatically apply all settings and forcibly restart the server. - {{% /alert %}} - - If `-Override 0` has been specified no further steps need to be taken and you can move on to the next section when the server has restarted. -1. To use all the recommended settings click `Apply all` to the first prompt. - - To selectively apply each setting select `Choose which to apply`. Each change will then be prompted with a Yes/No confirmation before applying. -1. Restart the machine when the script asks. +{{< section "/install-application-server/apply-recommended-security-measures.md">}} ## Add Antivirus Exclusions -1. If Windows Defender is not running on the server, ensure that the [Antivirus Exclusions][] have been added to the running antivirus software on the server and continue to the next section, otherwise follow these steps: - 1. Open a Windows PowerShell (x64) window as administrator. - 1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: - - ```powershell - cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" - ``` - - 1. Run the `Cortex.Innovation.Add.WindowsDefenderExclusions.ps1` script using the following command, modifying the `ApplicationServers` value to contain the NETBIOS name or fully qualified domain name of the server: - - ```powershell - .\Cortex.Innovation.Add.WindowsDefenderExclusions.ps1 -ApplicationServers @("app-server1") - ``` - - 1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK. - 1. A message will indicate that the script has completed successfully. +{{< section "/install-application-server/single-server/add-antivirus-exclusions.md">}} ## Check Port Usage -1. To check all necessary ports are free, follow these steps. - 1. Open a Windows PowerShell (x64) window as administrator. - 1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: - - ```powershell - cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" - ``` - - 1. Run the `Cortex.Innovation.Test.PortUsage.ps1` script using the following command, modifying the `ApplicationServers` value to contain the NETBIOS name or fully qualified domain name of the server: - - ```powershell - .\Cortex.Innovation.Test.PortUsage.ps1 -ApplicationServers @("app-server1") - ``` - - 1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK. - - 1. If all ports are free, the script will report the following: - - `All ports required by Cortex Innovation are free` - - If this is the case, continue to the next section. Otherwise, consult the messages returned by the script, which will give details about how to modify the `Cortex.Innovation.Install.Config.json` configuration file, in the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder, to use different ports. This will be used later during installation. - - The `Cortex.Innovation.Test.PortUsage.ps1` script cannot currently re-check modified ports in the configuration file so these need to be manually checked to see that they are free. +{{< section "/install-application-server/single-server/check-port-useage.md">}} ## Configure Installation Script -1. In the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder, locate the `Cortex.Innovation.Install.ps1` script and open it with a text editor. -1. Choose the tab below that matches the configuration for this installation, then update the script to match, changing the parameters according to the details given below: - - {{< tabpane lang="powershell" >}} - {{< tab header="CA Certs" >}} -.\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` - -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` - -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` - -ApiGatewayBasicAuthUsername "BasicAuthUser" ` - -ApiGatewayBasicAuthPassword "ADA9883B11BD4CDC908B8131B57944A4" ` - -CustomerName "Customer1" ` - -ApplicationServerIPv4Addresses @("192.168.1.1") ` - -ServerCertificatePath "C:\Install\Certificates\cert.pfx" ` - -ServerCertificatePassword "myPassword" ` - -SkipLoadBalancer ` - -Credential $Credential ` - -LdapConnectionDetails @{ - Host= "LDAP://ldapserver.fqdn.com:389" - UseSsl= $false - Username= "someUserName" - Password= "somePassword" - } ` - -AcceptEULA:$AcceptEula ` - *>&1 | Tee-Object -FilePath "cortex-app-install-log.txt" - {{< /tab >}} - {{< tab header="Self-Signed Certs" >}} -.\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` - -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` - -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` - -ApiGatewayBasicAuthUsername "BasicAuthUser" ` - -ApiGatewayBasicAuthPassword "ADA9883B11BD4CDC908B8131B57944A4" ` - -CustomerName "Customer1" ` - -ApplicationServerIPv4Addresses @("192.168.1.1") ` - -UseSelfSignedCertificates ` - -SkipLoadBalancer ` - -Credential $Credential ` - -LdapConnectionDetails @{ - Host= "LDAP://ldapserver.fqdn.com:389" - UseSsl= $false - Username= "someUserName" - Password= "somePassword" - } ` - -AcceptEULA:$AcceptEula ` - *>&1 | Tee-Object -FilePath "cortex-app-install-log.txt" - {{< /tab >}} - {{< /tabpane >}} - - | Name | Description | - |----------------------------------------------|-------------| - |`AppServicesPath` | Configure this value with the location of the App Services zip file on the server. | - |`BlockPackagesPath` | Configure this value with the location of the Block Packages zip file on the server. | - |`ApiGatewayBasicAuthUsername` | Configure this value with the username that will be used for Basic Authentication when making HTTPS requests to the API Gateway Service (e.g. starting production flows).

Currently only Basic Authentication using a single user is supported, OAuth2 will be supported in a future release.

This value will be needed [later, when upgrading Gateway][Upgrade Gateway]. | - |`ApiGatewayBasicAuthPassword` | Configure this value with the password that will be used for Basic Authentication when making HTTPS requests to the API Gateway Service (e.g. starting production flows). This should be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This value will be needed [later, when upgrading Gateway][Upgrade Gateway].| - |`CustomerName` | A name identifying the platform being installed. This must have no spaces or symbols. It will be appended to the node names that are displayed in Service Fabric Explorer. | - |`ApplicationServerIPv4Addresses` | The IPv4 address of the server.| - |`ServerCertificatePath` | The local path of a .PFX certificate file on the server. Environment variables cannot be used.

This is only needed if installing with CA Certificates (Recommended). The certificate should meet the [Certificate Requirements][].

This certificate will be used for:
  • Securing communication between the Application Services.
  • Allowing Application Services to identify themselves to clients such as Gateway.
  • Preventing unauthorised nodes from joining the single node cluster.
  • Connecting to Service Fabric Explorer from each of the Application Servers.
{{< alert type="warning" title="Warning" >}}It is critical to set a reminder to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.RolloverCertificates" title="update certificates" >}} in good time before they expire. If they expire then the platform will cease to function and {{< ahref path="Cortex.ServicePortal.MainDoc" title="CORTEX Service Portal" >}} must be contacted for support.{{< /alert >}}| - |`ServerCertificatePassword` | The password for the .PFX certificate file specified in `ServerCertificatePath`.

This is only needed if installing with CA Certificates (Recommended).| - |`UseSelfSignedCertificates` | Installs Application Services and required infrastructure using generated Self-Signed Certificates rather than CA Certificates.

Not recommended for production use. | - |`SkipLoadBalancer` | Installs Application Services and required infrastructure without installing a load balancer. | - |`Credential` | The credentials of the user which will be used to perform remote operations on the server. It must be a domain user that is a member of the local Administrators group on the server.

This does not need to be changed, a prompt will appear to enter this information when the script is run. | - |`LdapConnectionDetails` | The connection details to the LDAP server.

This must be configured with a valid `Host`, `Username`, `Password`, and whether the LDAP server uses SSL using `UseSsl`. {{< alert type="note" title="Note" >}}All fields but `UseSsl` can be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | - |`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. | - |`FilePath` | The filename that installation logs are written to. If this should be written to a different location than where the installation files are then a full path should be specified. | - - The `ApiGatewayBasicAuthUsername` and `ApiGatewayBasicAuthPassword` will be needed [later, when upgrading Gateway][Upgrade Gateway]. - - {{% alert title="Note" %}} -More advanced configuration (such as changing ports) can be undertaken by modifying the `Cortex.Innovation.Install.Config.json` file but this shouldn't be required for most installations. More information about this can be found at {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.AdvancedConfigSingleServer" title="Advanced Application Server and Load Balancer Configuration Changes" >}}. - {{% /alert %}} - -1. Save and close `Cortex.Innovation.Install.ps1`. +{{< section "/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md">}} ## Test Installation Script -1. Open a Windows PowerShell (x64) window as administrator. -1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: - - ```powershell - cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" - ``` - -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.Install.ps1 -WhatIf - ``` - -1. Please read the End User Licence Agreement which can be found [here][Eula]. Once you agree to the terms, add the flag `-AcceptEULA` to the command entered above, e.g: - - ```powershell - .\.ps1 -WhatIf -AcceptEULA - ``` - -1. Run the PowerShell command to test the installation script. -1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK. -1. A password prompt will appear. Enter a password which will be used to create a user in RabbitMQ. -1. Wait for the command to finish. It will display the output of the installation command without making any changes to the system. -1. Check that there have been no errors in the script; these would appear in red in the console. - - If there are no errors, continue to the next section; otherwise, check if the errors have any instructions for rectifying the issue and follow them. - - If there are no useful instructions, check that all previous steps have been followed correctly and, if not, rectify it and run the command again.

If this does not work, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for further assistance. The `WhatIf` script will have created a temporary version of the config file in the script location, showing what changes would be made to it when the script runs. The name is appended with `-WhatIf` (e.g. `Cortex.Innovation.Install.Config-WhatIf.json`). This file can be provided when obtaining support. +{{< section "/install-application-server/single-server/test-installation-script.md">}} ## Run Installation Script -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.Install.ps1 - ``` - -1. Please read the End User Licence Agreement which can be found [here][Eula]. Once you agree to the terms, add the flag `-AcceptEULA` to the command entered above, e.g: - - ```powershell - .\.ps1 -AcceptEULA - ``` - -1. Run the PowerShell command to install HA Services and the required infrastructure. -1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK. -1. A password prompt will appear. Enter a password which will be used to create a user in RabbitMQ. This should be entered carefully and recorded as it may be needed if seeking support from [{{% ctx %}} Service Portal][CORTEX Service Portal]. Press OK. -1. Wait for the script to finish running. This should take approximately 10 minutes. -1. Check that there have been no errors in the script; these would appear in red in the console. - - If there are any errors, then please follow any instructions given within them to rectify the situation, check your configuration files, and retry the installation. - - In some circumstances, retrying may error due to components being installed already. In this case please run the following command, followed by the original installation command: - - ```powershell - .\Cortex.Innovation.Uninstall.ps1 -SkipLoadBalancer - ``` - - If the errors do not give any instructions on how to rectify, see [Troubleshooting During Installation][] for further information; if this does not help then please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for assistance. +{{< section "/install-application-server/single-server/run-installation-script.md">}} ## Check Application Services @@ -259,37 +47,19 @@ More advanced configuration (such as changing ports) can be undertaken by modify ## Add Read and Execute access to Windows Crypto folder -Service Fabric requires access to the `C:\ProgramData\Microsoft\Crypto\` folder for the `Network Service` users. +{{< section "/install-application-server/single-server/add-permissions-to-crypto-folder.md">}} -Grant access to the `Network Service` user following these instructions: - -1. Open a Windows PowerShell (x64) window as administrator. -1. Run the following command: - -```bash -icacls "C:\ProgramData\Microsoft\Crypto\*" /grant *S-1-5-20:RX /t -``` +## Check Application Services -{{% alert title="Note" %}} -Some files might fail to be processed with `Access is denied`. This can be ignored. -{{% /alert %}} +{{< section "/install-application-server/single-server/check-application-services.md">}} ## Preserve installation files -Ensure that the installation files are backed up or kept on the server, especially the scripts and config files that have been modified. This will make it easier to perform further actions in future, such as troubleshooting, certificate rollover, uninstallation, reinstallation and updates. +{{< section "/preserve-installation-files.md">}} ## Next Steps? 1. [Install Web Application Server][] -[Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} [Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.AddInnovationTo72WebApplicationServer" >}} -[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.CertificateRequirements" >}} -[Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScript" >}} -[Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} [Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.Prerequisites" >}} -[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.AntivirusExclusions" >}} -[SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} -[CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} -[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} -[NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers.md index 9549d82c9..a46744067 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers.md @@ -304,7 +304,7 @@ More advanced configuration (such as changing ports) can be undertaken by modify ## Check Application Services -{{< section "/install-application-server/check-application-services/multi-server.md">}} +{{< section "/install-application-server/multi-server/check-application-services.md">}} ## Preserve installation files diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server.md index 4d9ca32d5..330374acd 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server.md @@ -11,284 +11,51 @@ This guide describes how to install the Application Server components on the ser ## Make Installation Artefacts Available -1. Copy the following artefacts to a folder on the server: - * Cortex Innovation {{< version >}} - Block Packages.zip - * Cortex Innovation {{< version >}} - App Services.zip - * Cortex Innovation {{< version >}} - App Server Install Scripts.zip - -1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. +{{< section "/install-application-server/make-installation-artefacts-available.md">}} ## Install Microsoft .NET Framework 4.7.2 -Microsoft Service Fabric requires a minimum of Microsoft .NET Framework 4.7.2 to be installed on the server. - -To find the version of the framework that is installed: - -1. On the Start menu, choose `Run`. -1. In the open box, enter `regedit.exe`. You must have administrative credentials to run regedit.exe. -1. In the Registry Editor, open the subkey `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\NET Framework Setup\NDP\v4\Full`. -1. If the `Full` subkey is not present, then you do not have the .NET Framework 4.5 or later installed. -1. Check for a `DWORD` value named `Release`. The existence of the Release DWORD indicates the .NET Framework 4.5 or newer has been installed on that computer. If the value is `461808` or over then at least .NET Framework 4.7.2 is installed and no further steps need to be taken. If it is not installed, continue with the following steps to install it. - -To install .NET Framework 4.7.2: - -1. Download the [.NET Framework 4.7.2][NET Framework 472] installer. -1. Double-click on the installer file to run it. -1. Follow the wizard to complete the installation. +{{< section "/install-application-server/install-dot-net-framework.md">}} ## Apply Recommended Security Measures -These are non-compulsory security measures, recommended to be applied to the server, in order to prevent potential attacks that exploit known industry security vulnerabilities. - -Applying these measures may impact other applications running on your server. Therefore, it is your responsibility to ensure that other applications and their clients will not be affected by the changes. - -### Only Use Recommended Encryption Algorithms and TLS Protocols - -A collection of registry settings need to be applied to guarantee your server is only using the recommended encryption algorithms and TLS protocols. Information about these settings can be found at [SSL Best Practices][]. - -{{% alert type="warning" title="Warning" %}}Disabling specific TLS versions or specific Cipher Suites can have impact on {{% ctx %}} components themselves as well as their communication capabilities with third party systems and services, e.g. Execution Service executing flows with blocks which communicate with 3rd parties via PowerShell or REST. All parties communicating together must support a shared protocol version and cipher suite, otherwise they will not be able to establish a secure communication link between each other.{{% /alert %}} - -The settings can be applied by running a script. Be aware that the server will be restarted when the script is run. Apply the settings by following these instructions: - -1. Open a Windows PowerShell (x64) window as administrator. -1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: - - ```powershell - cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" - ``` - -1. Run the `Cortex.Innovation.Install.SSLBestPractices.ps1` script using the following command: - - ```powershell - .\Cortex.Innovation.Install.SSLBestPractices.ps1 - ``` - - {{% alert title="Note" %}} -To avoid answering all of the prompts `-Override 0` can be added to the end of the script. This will automatically apply all settings and forcibly restart the server. - {{% /alert %}} - - If `-Override 0` has been specified no further steps need to be taken and you can move on to the next section when the server has restarted. -1. To use all the recommended settings click `Apply all` to the first prompt. - - To selectively apply each setting select `Choose which to apply`. Each change will then be prompted with a Yes/No confirmation before applying. -1. Restart the machine when the script asks. +{{< section "/install-application-server/apply-recommended-security-measures.md">}} ## Add Antivirus Exclusions -1. If Windows Defender is not running on the server, ensure that the [Antivirus Exclusions][] have been added to the running antivirus software on the server and continue to the next section, otherwise follow these steps: - 1. Open a Windows PowerShell (x64) window as administrator. - 1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: - - ```powershell - cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" - ``` - - 1. Run the `Cortex.Innovation.Add.WindowsDefenderExclusions.ps1` script using the following command, modifying the `ApplicationServers` value to contain the NETBIOS name or fully qualified domain name of the server: - - ```powershell - .\Cortex.Innovation.Add.WindowsDefenderExclusions.ps1 -ApplicationServers @("app-server1") - ``` - - 1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK. - 1. A message will indicate that the script has completed successfully. +{{< section "/install-application-server/single-server/add-antivirus-exclusions.md">}} ## Check Port Usage -1. To check all necessary ports are free, follow these steps. - 1. Open a Windows PowerShell (x64) window as administrator. - 1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: - - ```powershell - cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" - ``` - - 1. Run the `Cortex.Innovation.Test.PortUsage.ps1` script using the following command, modifying the `ApplicationServers` value to contain the NETBIOS name or fully qualified domain name of the server: - - ```powershell - .\Cortex.Innovation.Test.PortUsage.ps1 -ApplicationServers @("app-server1") - ``` - - 1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK. - - 1. If all ports are free, the script will report the following: - - `All ports required by Cortex Innovation are free` - - If this is the case, continue to the next section. Otherwise, consult the messages returned by the script, which will give details about how to modify the `Cortex.Innovation.Install.Config.json` configuration file, in the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder, to use different ports. This will be used later during installation. - - The `Cortex.Innovation.Test.PortUsage.ps1` script cannot currently re-check modified ports in the configuration file so these need to be manually checked to see that they are free. +{{< section "/install-application-server/single-server/check-port-useage.md">}} ## Configure Installation Script -1. In the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder, locate the `Cortex.Innovation.Install.ps1` script and open it with a text editor. -1. Choose the tab below that matches the configuration for this installation, then update the script to match, changing the parameters according to the details given below: - - {{< tabpane lang="powershell" >}} - {{< tab header="CA Certs" >}} -.\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` - -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` - -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` - -ApiGatewayBasicAuthUsername "BasicAuthUser" ` - -ApiGatewayBasicAuthPassword "ADA9883B11BD4CDC908B8131B57944A4" ` - -CustomerName "Customer1" ` - -ApplicationServerIPv4Addresses @("192.168.1.1") ` - -ServerCertificatePath "C:\Install\Certificates\cert.pfx" ` - -ServerCertificatePassword "myPassword" ` - -SkipLoadBalancer ` - -Credential $Credential ` - -LdapConnectionDetails @{ - Host= "LDAP://ldapserver.fqdn.com:389" - UseSsl= $false - Username= "someUserName" - Password= "somePassword" - } ` - -AcceptEULA:$AcceptEula ` - *>&1 | Tee-Object -FilePath "cortex-app-install-log.txt" - {{< /tab >}} - {{< tab header="Self-Signed Certs" >}} -.\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` - -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` - -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` - -ApiGatewayBasicAuthUsername "BasicAuthUser" ` - -ApiGatewayBasicAuthPassword "ADA9883B11BD4CDC908B8131B57944A4" ` - -CustomerName "Customer1" ` - -ApplicationServerIPv4Addresses @("192.168.1.1") ` - -UseSelfSignedCertificates ` - -SkipLoadBalancer ` - -Credential $Credential ` - -LdapConnectionDetails @{ - Host= "LDAP://ldapserver.fqdn.com:389" - UseSsl= $false - Username= "someUserName" - Password= "somePassword" - } ` - -AcceptEULA:$AcceptEula ` - *>&1 | Tee-Object -FilePath "cortex-app-install-log.txt" - {{< /tab >}} - {{< /tabpane >}} - - | Name | Description | - |----------------------------------------------|-------------| - |`AppServicesPath` | Configure this value with the location of the App Services zip file on the server. | - |`BlockPackagesPath` | Configure this value with the location of the Block Packages zip file on the server. | - |`ApiGatewayBasicAuthUsername` | Configure this value with the username that will be used for Basic Authentication when making HTTPS requests to the API Gateway Service (e.g. starting production flows).

Currently only Basic Authentication using a single user is supported, OAuth2 will be supported in a future release.

This value will be needed [later, when installing Gateway][Install Gateway]. | - |`ApiGatewayBasicAuthPassword` | Configure this value with the password that will be used for Basic Authentication when making HTTPS requests to the API Gateway Service (e.g. starting production flows). This should be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This value will be needed [later, when installing Gateway][Install Gateway].| - |`CustomerName` | A name identifying the platform being installed. This must have no spaces or symbols. It will be appended to the node names that are displayed in Service Fabric Explorer. | - |`ApplicationServerIPv4Addresses` | The IPv4 address of the server.| - |`ServerCertificatePath` | The local path of a .PFX certificate file on the server. Environment variables cannot be used.

This is only needed if installing with CA Certificates (Recommended). The certificate should meet the [Certificate Requirements][].

This certificate will be used for:
  • Securing communication between the Application Services.
  • Allowing Application Services to identify themselves to clients such as Gateway.
  • Preventing unauthorised nodes from joining the single node cluster.
  • Connecting to Service Fabric Explorer from each of the Application Servers.
{{< alert type="warning" title="Warning" >}}It is critical to set a reminder to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.RolloverCertificates" title="update certificates" >}} in good time before they expire. If they expire then the platform will cease to function and {{< ahref path="Cortex.ServicePortal.MainDoc" title="CORTEX Service Portal" >}} must be contacted for support.{{< /alert >}}| - |`ServerCertificatePassword` | The password for the .PFX certificate file specified in `ServerCertificatePath`.

This is only needed if installing with CA Certificates (Recommended).| - |`UseSelfSignedCertificates` | Installs Application Services and required infrastructure using generated Self-Signed Certificates rather than CA Certificates.

Not recommended for production use. | - |`SkipLoadBalancer` | Installs Application Services and required infrastructure without installing a load balancer. | - |`Credential` | The credentials of the user which will be used to perform remote operations on the server. It must be a domain user that is a member of the local Administrators group on the server.

This does not need to be changed, a prompt will appear to enter this information when the script is run. | - |`LdapConnectionDetails` | The connection details to the LDAP server.

This must be configured with a valid `Host`, `Username`, `Password`, and whether the LDAP server uses SSL using `UseSsl`. {{< alert type="note" title="Note" >}}All fields but `UseSsl` can be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | - |`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. | - |`FilePath` | The filename that installation logs are written to. If this should be written to a different location than where the installation files are then a full path should be specified. | - - The `ApiGatewayBasicAuthUsername` and `ApiGatewayBasicAuthPassword` will be needed [later, when installing Gateway][Install Gateway]. - - {{% alert title="Note" %}} -More advanced configuration (such as changing ports) can be undertaken by modifying the `Cortex.Innovation.Install.Config.json` file but this shouldn't be required for most installations. More information about this can be found at {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.AdvancedConfigSingleServer" title="Advanced Application Server and Load Balancer Configuration Changes" >}}. - {{% /alert %}} - -1. Save and close `Cortex.Innovation.Install.ps1`. +{{< section "/install-application-server/single-server/add-innovation-only/configure-installation-script.md">}} ## Test Installation Script -1. Open a Windows PowerShell (x64) window as administrator. -1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: - - ```powershell - cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" - ``` - -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.Install.ps1 -WhatIf - ``` - -1. Please read the End User Licence Agreement which can be found [here][Eula]. Once you agree to the terms, add the flag `-AcceptEULA` to the command entered above, e.g: - - ```powershell - .\.ps1 -WhatIf -AcceptEULA - ``` - -1. Run the PowerShell command to test the installation script. -1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK. -1. A password prompt will appear. Enter a password which will be used to create a user in RabbitMQ. -1. Wait for the command to finish. It will display the output of the installation command without making any changes to the system. -1. Check that there have been no errors in the script; these would appear in red in the console. - - If there are no errors, continue to the next section; otherwise, check if the errors have any instructions for rectifying the issue and follow them. - - If there are no useful instructions, check that all previous steps have been followed correctly and, if not, rectify it and run the command again.

If this does not work, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for further assistance. The `WhatIf` script will have created a temporary version of the config file in the script location, showing what changes would be made to it when the script runs. The name is appended with `-WhatIf` (e.g. `Cortex.Innovation.Install.Config-WhatIf.json`). This file can be provided when obtaining support. +{{< section "/install-application-server/single-server/test-installation-script.md">}} ## Run Installation Script -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.Install.ps1 - ``` -1. Please read the End User Licence Agreement which can be found [here][Eula]. Once you agree to the terms, add the flag `-AcceptEULA` to the command entered above, e.g: - - ```powershell - .\.ps1 -AcceptEULA - ``` - -1. Run the PowerShell command to install HA Services and the required infrastructure. -1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK. -1. A password prompt will appear. Enter a password which will be used to create a user in RabbitMQ. This should be entered carefully and recorded as it may be needed if seeking support from [{{% ctx %}} Service Portal][CORTEX Service Portal]. Press OK. -1. Wait for the script to finish running. This should take approximately 10 minutes. -1. Check that there have been no errors in the script; these would appear in red in the console. - - If there are any errors, then please follow any instructions given within them to rectify the situation, check your configuration files, and retry the installation. - - In some circumstances, retrying may error due to components being installed already. In this case please run the following command, followed by the original installation command: - - ```powershell - .\Cortex.Innovation.Uninstall.ps1 -SkipLoadBalancer - ``` - - If the errors do not give any instructions on how to rectify, see [Troubleshooting During Installation][] for further information; if this does not help then please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for assistance. - -## Check Application Services - -{{< section "/install-application-server/check-application-services/single-server.md">}} +{{< section "/install-application-server/single-server/run-installation-script.md">}} ## Add Read and Execute access to Windows Crypto folder -Service Fabric requires access to the `C:\ProgramData\Microsoft\Crypto\` folder for the `Network Service` users. +{{< section "/install-application-server/single-server/add-permissions-to-crypto-folder.md">}} -Grant access to the `Network Service` user following these instructions: - -1. Open a Windows PowerShell (x64) window as administrator. -1. Run the following command: - -```bash -icacls "C:\ProgramData\Microsoft\Crypto\*" /grant *S-1-5-20:RX /t -``` +## Check Application Services -{{% alert title="Note" %}} -Some files might fail to be processed with `Access is denied`. This can be ignored. -{{% /alert %}} +{{< section "/install-application-server/single-server/check-application-services.md">}} ## Preserve installation files -Ensure that the installation files are backed up or kept on the server, especially the scripts and config files that have been modified. This will make it easier to perform further actions in future, such as troubleshooting, certificate rollover, uninstallation, reinstallation and updates. +{{< section "/preserve-installation-files.md">}} ## Next Steps? 1. [Install Web Application Server][] -[Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} -[Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallWebApplicationServer" >}} -[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.CertificateRequirements" >}} -[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScript" >}} -[Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} -[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.Prerequisites" >}} -[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.AntivirusExclusions" >}} -[SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} -[CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} -[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} -[NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}} +[Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallWebApplicationServer" >}} +[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.Prerequisites" >}} \ No newline at end of file From 051b6810ec2fd558a94bb65719b179041a5bbaad Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Fri, 20 Oct 2023 14:49:50 +0100 Subject: [PATCH 02/21] added missing file to commit --- .../single-server-without-ha/install-application-server.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md index 557eb3f8f..d587211a7 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md @@ -41,10 +41,6 @@ This guide describes how to install the Application Server components on the ser {{< section "/install-application-server/single-server/run-installation-script.md">}} -## Check Application Services - -{{< section "/install-application-server/check-application-services/single-server.md">}} - ## Add Read and Execute access to Windows Crypto folder {{< section "/install-application-server/single-server/add-permissions-to-crypto-folder.md">}} From dd485a39b8d029435f8431ddd022725759f0e5fb Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Thu, 2 Nov 2023 21:33:44 +0000 Subject: [PATCH 03/21] added debugger install steps and started to update all links --- .../add-innovation-only/licensing.md | 3 + .../add-innovation-to-7.2/licensing.md | 3 + .../assign-certificate-friendly-name.md | 11 + ...eway-user-additional-folder-permissions.md | 49 ++++ .../grant-gateway-user-folder-permissions.md | 24 ++ .../make-installation-artefacts-available.md | 10 + ...ll-application-and-loadbalancer-servers.md | 18 +- .../install-web-application-server.md | 45 +--- .../install-application-server.md | 2 +- ...ll-application-and-loadbalancer-servers.md | 79 +++--- .../install-web-application-server/_index.md | 10 + .../perform-debugger-installation.md | 65 +++++ .../perform-gateway-installation.md} | 225 +----------------- .../prerequisites.md | 126 ++++++++++ .../multiple-server-with-ha/prerequisites.md | 28 +-- data/urls.toml | 4 + 16 files changed, 382 insertions(+), 320 deletions(-) create mode 100644 content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/licensing.md create mode 100644 content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/licensing.md create mode 100644 content/en/docs/2023.11/_shared/install-web-application-server/assign-certificate-friendly-name.md create mode 100644 content/en/docs/2023.11/_shared/install-web-application-server/grant-gateway-user-additional-folder-permissions.md create mode 100644 content/en/docs/2023.11/_shared/install-web-application-server/grant-gateway-user-folder-permissions.md create mode 100644 content/en/docs/2023.11/_shared/install-web-application-server/make-installation-artefacts-available.md create mode 100644 content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/_index.md create mode 100644 content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md rename content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/{install-web-application-server.md => install-web-application-server/perform-gateway-installation.md} (53%) create mode 100644 content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md diff --git a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/licensing.md b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/licensing.md new file mode 100644 index 000000000..88853d480 --- /dev/null +++ b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/licensing.md @@ -0,0 +1,3 @@ +Ensure that a valid {{% ctx %}} licence file named `Cortex.lic` exists on the Web Application server, in the location `%ProgramData%\Cortex\Licences`. If it does not, follow the instructions located at [Licensing Requirements][]. + +[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.LicensingRequirements" >}} diff --git a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/licensing.md b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/licensing.md new file mode 100644 index 000000000..34a467ecc --- /dev/null +++ b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/licensing.md @@ -0,0 +1,3 @@ +Ensure that a valid {{% ctx %}} licence file named `Cortex.lic` exists on the Web Application server, in the location `%ProgramData%\Cortex\Licences`. If it does not, follow the instructions located at [Licensing Requirements][]. + +[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.LicensingRequirements" >}} diff --git a/content/en/docs/2023.11/_shared/install-web-application-server/assign-certificate-friendly-name.md b/content/en/docs/2023.11/_shared/install-web-application-server/assign-certificate-friendly-name.md new file mode 100644 index 000000000..f68eafd71 --- /dev/null +++ b/content/en/docs/2023.11/_shared/install-web-application-server/assign-certificate-friendly-name.md @@ -0,0 +1,11 @@ +Once the certificate has been imported, a `Friendly Name` should be assigned which will be used in the [Configure {{% ctx %}} Gateway Installation Script][Configure CORTEX Gateway Installation Script] to enable the installation script to identify the certificate to be used for the website: + +1. Click the Windows button (`Start`). +1. Type `certlm.msc` and press `Enter` to open the Certificate Manager dialog. +1. Expand `Personal` and select `Certificates`. +1. You should see your certificate in this store. +1. Right-click on the certificate and select `Properties`. +1. On the `General` tab in the `Friendly Name` text box, enter a name to be used for the certificate. +1. Click `OK`. + +[Configure CORTEX Gateway Installation Script]: {{< ref "#configure-cortex-gateway-installation-script" >}} diff --git a/content/en/docs/2023.11/_shared/install-web-application-server/grant-gateway-user-additional-folder-permissions.md b/content/en/docs/2023.11/_shared/install-web-application-server/grant-gateway-user-additional-folder-permissions.md new file mode 100644 index 000000000..38e7a5e61 --- /dev/null +++ b/content/en/docs/2023.11/_shared/install-web-application-server/grant-gateway-user-additional-folder-permissions.md @@ -0,0 +1,49 @@ +#### Cortex Blocks Provider Host folder + +Check that the {{% ctx %}} Gateway `Application Pool` user has rights to the `Cortex Blocks Provider Host folder` folder using the following steps: + +1. Navigate to `C:\ProgramData\Cortex` +1. Right-click on the `Cortex Blocks Provider Host` folder and click `Properties`. +1. In the dialog, click the `Security` tab. +1. Check the `Application Pool` user for Gateway is listed in the `Group or user names` and has `Modify` permissions. +1. If the `Application Pool` user for Gateway is not listed: + 1. Click the `Edit...` button. + 1. Click the `Add...` button. + 1. Enter the username of the application pool user and click `OK`. + 1. In the `Permissions` section at the bottom, check `Modify`. + 1. Click `OK`. +1. If the `Application Pool` user for Gateway is listed but does not have permissions: + 1. Click the `Edit...` button. + 1. Select the `Application Pool` user. + 1. Check `Modify`. + 1. Click `OK`. + +#### Repo folder + +Check that the {{% ctx %}} Gateway `Application Pool` user has rights to the `Repo` folder using the following steps: + +1. Check where the `Repo` folder is located + 1. Navigate to the `gateway` IIS folder (usually `%SystemDrive%\inetpub\wwwroot\Cortex\gateway`, e.g. `C:\inetpub\wwwroot\Cortex\gateway`) + 1. Open the `web.config` file. + 1. Find the value of the `connectionString` named `CortexRepositories` +1. Navigate to the `Repo` folder, not opening it. +1. Right-click on the `Repo` folder and click `Properties`. +1. In the dialog, click the `Security` tab. +1. Check the `Application Pool` user for Gateway is listed in the `Group or user names` and has `Modify` permissions. +1. If the `Application Pool` user for Gateway is not listed: + 1. Click the `Edit...` button. + 1. Click the `Add...` button. + 1. Enter the username of the application pool user and click `OK`. + 1. In the `Permissions` section at the bottom, check `Modify`. + 1. Click `OK`. +1. If the `Application Pool` user for Gateway is listed but does not have permissions: + 1. Click the `Edit...` button. + 1. Select the `Application Pool` user. + 1. Check `Modify`. + 1. Click `OK`. + +#### Perform an IIS reset + +1. Open a Windows PowerShell (x64) window as administrator. +1. Run the following command: `iisreset`. +1. Wait for the action to complete. diff --git a/content/en/docs/2023.11/_shared/install-web-application-server/grant-gateway-user-folder-permissions.md b/content/en/docs/2023.11/_shared/install-web-application-server/grant-gateway-user-folder-permissions.md new file mode 100644 index 000000000..b3c483c2f --- /dev/null +++ b/content/en/docs/2023.11/_shared/install-web-application-server/grant-gateway-user-folder-permissions.md @@ -0,0 +1,24 @@ +The following folders require `Modify` permission to allow creating the `NuGet` folders and its `NuGet.Config` file within: + +* `C:\Windows\System32\config\systemprofile\AppData\Roaming` +* `C:\Windows\SysWOW64\config\systemprofile\AppData\Roaming` + +For each folder, perform the following steps: + +1. Navigate to the `AppData` folder. +1. Right-click on the `Roaming` folder and click `Properties`. +1. In the dialog, click the `Security` tab. +1. Check the `Application Pool` user that will be used for {{% ctx %}} Gateway is listed in the `Group or user names` and has `Modify` permissions. +1. If the `Application Pool` user that will be used for {{% ctx %}} Gateway is not listed: + 1. Click the `Edit...` button. + 1. Click the `Add...` button. + 1. Enter the username of the application pool user and click `OK`. + 1. In the `Permissions` section at the bottom, check `Modify`. + 1. Click `OK`. + 1. Click `Yes` to change the permission to the folder. +1. If the `Application Pool` user that will be used for {{% ctx %}} Gateway is listed but does not have permissions: + 1. Click the `Edit...` button. + 1. Select the `Application Pool` user. + 1. Check `Modify`. + 1. Click `OK`. + 1. Click `Yes` to change the permission to the folder. diff --git a/content/en/docs/2023.11/_shared/install-web-application-server/make-installation-artefacts-available.md b/content/en/docs/2023.11/_shared/install-web-application-server/make-installation-artefacts-available.md new file mode 100644 index 000000000..908a6a01e --- /dev/null +++ b/content/en/docs/2023.11/_shared/install-web-application-server/make-installation-artefacts-available.md @@ -0,0 +1,10 @@ +1. Copy the following artefacts to a folder on the machine: + + * Cortex Innovation {{< version >}} - App Services.zip + * Cortex Innovation {{< version >}} - App Server Install Scripts.zip + * Cortex Innovation {{< version >}} - Block Packages.zip + * Cortex Innovation {{< version >}} - Gateway.zip + * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip + +1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. +1. Extract the `Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip` zip file to a folder with the same name. diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md index 98205308a..fbd35f550 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md @@ -308,21 +308,21 @@ More advanced configuration (such as changing ports) can be undertaken by modify ## Preserve installation files -Ensure that the installation files are backed up or kept on the server, especially the scripts and config files that have been modified. This will make it easier to perform further actions in future, such as troubleshooting, certificate rollover, uninstallation, reinstallation and updates. +{{< section "/preserve-installation-files.md">}} ## Next Steps? 1. [Upgrade v7.2 Gateway to Include Innovation][] -[Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} -[Upgrade v7.2 Gateway to Include Innovation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AddInnovationTo72WebApplicationServer" >}} -[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.CertificateRequirements" >}} -[Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScript" >}} -[Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} -[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AntivirusExclusions" >}} -[Prerequisites for adding Innovation to v7.2]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.Prerequisites" >}} [alternative load balancer]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AltLoadBalancer" >}} -[SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} +[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AntivirusExclusions" >}} +[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.CertificateRequirements" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} +[Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} +[Prerequisites for adding Innovation to v7.2]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.Prerequisites" >}} [NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}} +[SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} +[Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} +[Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScript" >}} +[Upgrade v7.2 Gateway to Include Innovation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AddInnovationTo72WebApplicationServer" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server.md index 2ecd386f0..2327a2220 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server.md @@ -20,46 +20,17 @@ The steps to add Innovation functionality to 7.2 are: We recommend that the single-node Service Fabric instance, used by {{% ctx %}} Gateway as a Debugger instance, and {{% ctx %}} Gateway are installed on the same Web Application Server. {{% /alert %}} -1. Copy the following artefacts to a folder on the machine: - - * Cortex Innovation {{< version >}} - Block Packages.zip - * Cortex Innovation {{< version >}} - Gateway.zip - * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip - -1. Extract the `Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip` zip file to a folder with the same name. +{{< section "/install-web-application-server/make-installation-artefacts-available.md">}} ## Install Prerequisites ### Licensing -Ensure that a valid {{% ctx %}} licence file named `Cortex.lic` exists on the Web Application server, in the location `%ProgramData%\Cortex\Licences`. If it does not, follow the instructions located at [Licensing Requirements][]. +{{< section "/install-web-application-server/add-innovation-to-7.2/licensing.md" >}} ### Grant folder permissions to the {{% ctx %}} Gateway Application Pool User -The following folders require `Modify` permission to allow creating the `NuGet` folders and its `NuGet.Config` file within: - -* `C:\Windows\System32\config\systemprofile\AppData\Roaming` -* `C:\Windows\SysWOW64\config\systemprofile\AppData\Roaming` - -For each folder, perform the following steps: - -1. Navigate to the `AppData` folder. -1. Right-click on the `Roaming` folder and click `Properties`. -1. In the dialog, click the `Security` tab. -1. Check the `Application Pool` user for Gateway is listed in the `Group or user names` and has `Modify` permissions. -1. If the `Application Pool` user for Gateway is not listed: - 1. Click the `Edit...` button. - 1. Click the `Add...` button. - 1. Enter the username of the application pool user and click `OK`. - 1. In the `Permissions` section at the bottom, check `Modify`. - 1. Click `OK`. - 1. Click `Yes` to change the permission to the folder. -1. If the `Application Pool` user for Gateway is listed but does not have permissions: - 1. Click the `Edit...` button. - 1. Select the `Application Pool` user. - 1. Check `Modify`. - 1. Click `OK`. - 1. Click `Yes` to change the permission to the folder. +{{< section "/install-web-application-server/grant-gateway-user-folder-permissions.md">}} ### Certificate Requirements @@ -67,15 +38,7 @@ In order to ensure that the correct certificate is used during the upgrade of {{ #### Assign Certificate Friendly Name -A Friendly Name should be assigned to the certificate being used for the Cortex Website. This will be used in the [Configure {{% ctx %}} Gateway Installation Script][Configure CORTEX Gateway Installation Script] to assign the correct certificate to the site: - -1. Click the Windows button (`Start`). -1. Type `certlm.msc` and press `Enter` to open the Certificate Manager dialog. -1. Expand `Personal` and select `Certificates`. -1. You should see your certificate in this store. -1. Right-click on the certificate and select `Properties`. -1. On the `General` tab in the `Friendly Name` text box, enter a name to be used for the certificate. -1. Click `OK`. +{{< section "/install-web-application-server/assign-certificate-friendly-name.md">}} ## Perform Debugger Installation diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md index b2553f6f7..d587211a7 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md @@ -47,7 +47,7 @@ This guide describes how to install the Application Server components on the ser ## Check Application Services -{{< section "/install-application-server/check-application-services/single-server.md">}} +{{< section "/install-application-server/single-server/check-application-services.md">}} ## Preserve installation files diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers.md index d0180d501..259dc4961 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers.md @@ -77,48 +77,50 @@ To avoid answering all of the prompts `-Override 0` can be added to the end of t ## Add Antivirus Exclusions -1. If Windows Defender is not running on the Application Servers, ensure that the [Antivirus Exclusions][] have been added to the running antivirus software on each of the Application Servers and continue to the next section, otherwise follow these steps: - 1. Open a Windows PowerShell (x64) window as administrator. - 1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: +If Windows Defender is not running on the Application Servers, ensure that the [Antivirus Exclusions][] have been added to the running antivirus software on each of the Application Servers and continue to the next section, otherwise follow these steps: - ```powershell - cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" - ``` +1. Open a Windows PowerShell (x64) window as administrator. +1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: + + ```powershell + cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" + ``` - 1. Run the `Cortex.Innovation.Add.WindowsDefenderExclusions.ps1` script using the following command, modifying the `ApplicationServers` value to contain the NETBIOS names or fully qualified domain names of the Application Servers: +1. Run the `Cortex.Innovation.Add.WindowsDefenderExclusions.ps1` script using the following command, modifying the `ApplicationServers` value to contain the NETBIOS names or fully qualified domain names of the Application Servers: - ```powershell - .\Cortex.Innovation.Add.WindowsDefenderExclusions.ps1 -ApplicationServers @("app-server1", "app-server2", "app-server3") - ``` + ```powershell + .\Cortex.Innovation.Add.WindowsDefenderExclusions.ps1 -ApplicationServers @("app-server1", "app-server2", "app-server3") + ``` - 1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on all Application Servers and press OK. - 1. A message will indicate that the script has completed successfully. +1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on all Application Servers and press OK. +1. A message will indicate that the script has completed successfully. ## Check Port Usage -1. To check all necessary ports are free, follow these steps. - 1. Open a Windows PowerShell (x64) window as administrator. - 1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: +To check all necessary ports are free, follow these steps. - ```powershell - cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" - ``` +1. Open a Windows PowerShell (x64) window as administrator. +1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: - 1. Run the `Cortex.Innovation.Test.PortUsage.ps1` script using the following command, modifying the `ApplicationServers` value to contain the NETBIOS names or fully qualified domain names of the Application Servers: + ```powershell + cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" + ``` + +1. Run the `Cortex.Innovation.Test.PortUsage.ps1` script using the following command, modifying the `ApplicationServers` value to contain the NETBIOS names or fully qualified domain names of the Application Servers: - ```powershell - .\Cortex.Innovation.Test.PortUsage.ps1 -ApplicationServers @("app-server1", "app-server2", "app-server3") - ``` + ```powershell + .\Cortex.Innovation.Test.PortUsage.ps1 -ApplicationServers @("app-server1", "app-server2", "app-server3") + ``` - 1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on all Application Servers and press OK. +1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on all Application Servers and press OK. - 1. If all ports are free, the script will report the following for each Application Server: +1. If all ports are free, the script will report the following for each Application Server: - `All ports required by Cortex Innovation are free` + `All ports required by Cortex Innovation are free` - If this is the case, continue to the next section. Otherwise, consult the messages returned by the script, which will give details about how to modify the `Cortex.Innovation.Install.Config.json` configuration file, in the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder, to use different ports. This will be used later during installation. + If this is the case, continue to the next section. Otherwise, consult the messages returned by the script, which will give details about how to modify the `Cortex.Innovation.Install.Config.json` configuration file, in the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder, to use different ports. This will be used later during installation. - The `Cortex.Innovation.Test.PortUsage.ps1` script cannot currently re-check modified ports in the configuration file so these need to be manually checked to see that they are free. + The `Cortex.Innovation.Test.PortUsage.ps1` script cannot currently re-check modified ports in the configuration file so these need to be manually checked to see that they are free. ## Configure Installation Script @@ -218,8 +220,8 @@ To avoid answering all of the prompts `-Override 0` can be added to the end of t |----------------------------------------------|-------------| |`AppServicesPath` | Configure this value with the location of the Application Services zip file on the Application Server used for installation. | |`BlockPackagesPath` | Configure this value with the location of the Block Packages zip file on the Application Server used for installation. | - |`ApiGatewayBasicAuthUsername` | Configure this value with a username that can be used to make HTTPS requests to the API Gateway Service using Basic Authentication (e.g. starting flows). This username will be used by Gateway for all HTTPS requests to the API Gateway Service.

For security reasons it is recommended that the default value `BasicAuthUser` should be changed.

This value will be needed [later, when installing Gateway][Install Gateway].

This username can also be used by external services for HTTPS requests to the API Gateway Service but is not recommended; these requests should use an OAuth2 session for an authorised Active Directory user.| - |`ApiGatewayBasicAuthPassword` | Configure this value with the password for the username specified for `ApiGatewayBasicAuthUsername`.

This password should be [{{% ctx %}} Encrypted][CORTEX Encrypted]. For security reasons it is recommended that the default value `ADA9883B11BD4CDC908B8131B57944A4` should be changed.

This value will be needed [later, when installing Gateway][Install Gateway].| + |`ApiGatewayBasicAuthUsername` | Configure this value with a username that can be used to make HTTPS requests to the API Gateway Service using Basic Authentication (e.g. starting flows). This username will be used by Gateway for all HTTPS requests to the API Gateway Service.

For security reasons it is recommended that the default value `BasicAuthUser` should be changed.

This value will be needed later, [when installing the Flow Debugger][Install Debugger] and [when installing Gateway][Install Gateway].

This username can also be used by external services for HTTPS requests to the API Gateway Service but is not recommended; these requests should use an OAuth2 session for an authorised Active Directory user.| + |`ApiGatewayBasicAuthPassword` | Configure this value with the password for the username specified for `ApiGatewayBasicAuthUsername`.

This password should be [{{% ctx %}} Encrypted][CORTEX Encrypted]. For security reasons it is recommended that the default value `ADA9883B11BD4CDC908B8131B57944A4` should be changed.

This value will be needed later, [when installing the Flow Debugger][Install Debugger] and [when installing Gateway][Install Gateway].| |`CustomerName` | A name identifying the platform being installed. This must have no spaces or symbols. It will be appended to the node names that are displayed in Service Fabric Explorer. | |`ApplicationServerIPv4Addresses` | The IPv4 addresses of the Application Servers. The first of these must be the Application Server used for installation. | |`LoadBalancerServerIPv4Address` | The IPv4 address of the Load Balancer Server. This is only needed if using the built-in load balancer. | @@ -308,21 +310,22 @@ More advanced configuration (such as changing ports) can be undertaken by modify ## Preserve installation files -Ensure that the installation files are backed up or kept on the server, especially the scripts and config files that have been modified. This will make it easier to perform further actions in future, such as troubleshooting, certificate rollover, uninstallation, reinstallation and updates. +{{< section "/preserve-installation-files.md">}} ## Next Steps? 1. [Install Web Application Server][] -[Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} -[Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallWebApplicationServer" >}} -[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.CertificateRequirements" >}} -[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScript" >}} -[Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} -[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AntivirusExclusions" >}} -[Prerequisites for installing Innovation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Prerequisites" >}} [alternative load balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AltLoadBalancer" >}} -[SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} +[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AntivirusExclusions" >}} +[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.CertificateRequirements" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} +[Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} +[Install Debugger]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureFlowDebuggerInstallationScript" >}} +[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} +[Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallWebApplicationServer" >}} [NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}} +[Prerequisites for installing Innovation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Prerequisites" >}} +[SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} +[Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/_index.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/_index.md new file mode 100644 index 000000000..a2bf8bace --- /dev/null +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/_index.md @@ -0,0 +1,10 @@ +--- +title: "Install the Web Application Server" +linkTitle: "Install Web Application Server" +description: "Information about installing the Web Application Server." +weight: 40 +--- + +This guide describes how to install the Web Application Server. Please ensure that [Install Application Servers and Load Balancer][] has been completed before starting this installation. + +[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md new file mode 100644 index 000000000..38cec0a09 --- /dev/null +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md @@ -0,0 +1,65 @@ +--- +title: "Perform Debugger Installation" +linkTitle: "Perform Debugger Installation" +description: "Information about installing the Flow Debugger." +weight: 30 +--- + +# {{% param title %}} + +This guide describes how to install the Web Application Server. Please ensure that [Install Application Servers and Load Balancer][] has been completed before starting this installation. + +## Perform Debugger Installation + +{{% alert title="Important" color="warning" %}} +{{< ctx >}} Gateway requires a local instance of the Application Server components to enable the debugging of flows. +{{% /alert %}} + +### Add Antivirus Exclusions + +{{< section "/install-application-server/single-server/add-antivirus-exclusions.md">}} + +### Check Port Usage + +{{< section "/install-application-server/single-server/check-port-useage.md">}} + +### Configure Installation Script + +{{< section "/install-application-server/single-server/add-innovation-only/configure-installation-script.md">}} + +### Test Installation Script + +{{< section "/install-application-server/single-server/test-installation-script.md">}} + +### Run Installation Script + +{{< section "/install-application-server/single-server/run-installation-script.md">}} + +### Add Read and Execute access to Windows Crypto folder + +{{< section "/install-application-server/single-server/add-permissions-to-crypto-folder.md">}} + +### Check Application Services + +{{< section "/install-application-server/single-server/check-application-services.md">}} + +## Preserve installation files + +{{< section "/preserve-installation-files.md">}} + +## Next Steps? + +1. [Setup {{% ctx %}} Gateway][Setup CORTEX Gateway] + +[Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} +[Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} +[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScript" >}} +[CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} +[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} +[Get CORTEX Gateway Application Pool User]: {{< ref "#get-cortex-gateway-application-pool-user" >}} +[Import Certificate Manually]: {{< ref "#import-certificate-manually" >}} +[Import Root Certificate]: {{< ref path="#import-root-certificate" >}} +[Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallApplicationServer" >}} +[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} +[Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} +[Setup CORTEX Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.SetupGateway" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md similarity index 53% rename from content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server.md rename to content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md index 1a9465e5e..e5f4f7995 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md @@ -1,169 +1,14 @@ --- -title: "Install the Web Application Server" -linkTitle: "Install Web Application Server" -description: "Information about installing the Web Application Server." -weight: 40 +title: "Perform Gateway Installation" +linkTitle: "Perform Gateway Installation" +description: "Information about installing {{% ctx %}} Gateway." +weight: 20 --- # {{% param title %}} This guide describes how to install the Web Application Server. Please ensure that [Install Application Servers and Load Balancer][] has been completed before starting this installation. -## Make Installation Artefacts Available - -{{% alert title="Note" %}} -We recommend that the single-node Service Fabric instance, used by {{% ctx %}} Gateway as a Debugger instance, and {{% ctx %}} Gateway are installed on the same Web Application Server. -{{% /alert %}} - -1. Copy the following artefacts to a folder on the machine: - * Cortex Innovation {{< version >}} - Block Packages.zip - * Cortex Innovation {{< version >}} - Gateway.zip - * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip - -1. Extract the `Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip` zip file to a folder with the same name. - -## Install Prerequisites - -### Licensing - -Ensure that a valid {{% ctx %}} licence file named `Cortex.lic` exists on the Web Application server, in the location `%ProgramData%\Cortex\Licences`. If it does not, follow the instructions located at [Licensing Requirements][]. - -### Install SQL Server or SQL Express - -1. Use one of the following installation guides to install SQL Server or SQL Server Express: - - * {{% ctx %}} Innovation - SQL Server 2016 Express Installation Guide - * {{% ctx %}} Innovation - SQL Server 2016 Installation Guide - * {{% ctx %}} Innovation - SQL Server 2019 Installation Guide - -### Get {{% ctx %}} Gateway Application Pool User - -A domain user account is required for the {{% ctx %}} Gateway application pool and must be created prior to performing the installation below. - -This user account is required to enable {{% ctx %}} Gateway to access the {{% ctx %}} database, with the following roles: - -* dbcreator -* public - -To add roles to database users take the following steps: - -1. Open SQL Server Management Studio on the Web Application Server and log in. -1. Expand the server node, then `Security` then `Logins`. -1. If the user that will run the {{% ctx %}} Gateway application pool is not in the list of logins, take the following steps, otherwise skip to step 4: - - 1. Right-click the `Logins` node and click `New Login...`. - 1. Enter the application pool user in the `Login name` box. - 1. On the left pane, click `Server Roles`. - 1. Check `public` and `dbcreator` - 1. Click `OK`. - -1. If the user that will run the {{% ctx %}} Gateway application pool is in the list of logins, take the following steps: - - 1. Right-click on the application pool user. - 1. Click `Properties`. - 1. On the left pane, click `Server Roles`. - 1. Check `public` and `dbcreator`. - 1. Click `OK`. - -In line with best practices, this account should not be given administrator rights, nor should it be used for any purposes other than those specified for {{% ctx %}} Gateway. - -### Grant folder permissions to the {{% ctx %}} Gateway Application Pool User - -The following folders require `Modify` permission to allow creating the `NuGet` folders and its `NuGet.Config` file within: - -* `C:\Windows\System32\config\systemprofile\AppData\Roaming` -* `C:\Windows\SysWOW64\config\systemprofile\AppData\Roaming` - -For each folder, perform the following steps: - -1. Navigate to the `AppData` folder. -1. Right-click on the `Roaming` folder and click `Properties`. -1. In the dialog, click the `Security` tab. -1. Check the `Application Pool` user that will be used for {{% ctx %}} Gateway is listed in the `Group or user names` and has `Modify` permissions. -1. If the `Application Pool` user that will be used for {{% ctx %}} Gateway is not listed: - 1. Click the `Edit...` button. - 1. Click the `Add...` button. - 1. Enter the username of the application pool user and click `OK`. - 1. In the `Permissions` section at the bottom, check `Modify`. - 1. Click `OK`. - 1. Click `Yes` to change the permission to the folder. -1. If the `Application Pool` user that will be used for {{% ctx %}} Gateway is listed but does not have permissions: - 1. Click the `Edit...` button. - 1. Select the `Application Pool` user. - 1. Check `Modify`. - 1. Click `OK`. - 1. Click `Yes` to change the permission to the folder. - -### Certificate Requirements - -{{% ctx %}} Gateway requires an X.509 SSL certificate to be installed on the Web Application Server. The certificate must have the following properties: - -* Enhanced Key Usage: `Server Authentication` and `Client Authentication` -* Subject Alternative Names (SAN): At minimum the FQDN of the server. It can also include NetBIOS Name, IP address, localhost, 127.0.0.1 - -If the user tries to navigate to an address not in the SAN list, then they will receive a certificate error. - -{{% alert title="Important" color="warning" %}} -Do not reuse any auto-generated self-signed certificates as they do not meet the requirements for Gateway. -
-Certificates, wildcard certificates and manually created self-signed certificates can be used. However, the latter are not recommended for production instances. -Details on how to create a self-signed certificate can be found at {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.CreateSelfSignedCertificates" title="Create Self-Signed Certificates" >}}. -
-It is possible to reuse the certificate used when {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PerformDebuggerInstallation" title="installing the Debugger" >}}, as long as it is not an auto-generated self-signed certificate; If doing so, you should {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyName" title="Assign a Certificate Friendly Name" >}} and set the `ImportCertificate` parameter to `$false` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScript" title="Configure CORTEX Gateway Installation Script" >}} to ensure use of the correct certificate and to prevent it from being overwritten. -{{% /alert %}} - -#### Import Root Certificate - -{{% alert title="Note" %}}This step is only required if using a self-signed certificate signed by your own Root Certificate e.g. OpenSSL. If this is not the case proceed to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ImportCertificateManually" title="Import Certificate Manually" >}} {{% /alert %}} - -This step must be carried out prior to the installation otherwise the URL validation will fail. In order to import the Root Certificate, ensure that the file is in a known location on this server and complete the following steps: - -1. Using Windows File Explorer navigate to the location of the Root Certificate file. -1. Double click on the Root Certificate file to import the certificate into the Windows Certificate Store. Perform the following steps: - - 1. Select `Local Machine` then click `Next`. - 1. Click `Next`. - 1. Enter the Export Password which the certificate was generated with then click `Next`. - 1. Select `Place all certificates in the following store`. - 1. Click `Browse…`. - 1. Select `Trusted Root Certification Authorities`, click `OK` then click `Next`. - 1. Click `Finish`. - 1. [Import][Import Certificate Manually] the X.509 SSL certificate. - -#### Import Certificate Manually - -{{% alert title="Note" %}}The certificate can be imported automatically by setting the `ImportCertificate` parameter to `$true` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScript" title="Configure CORTEX Gateway Installation Script" >}}. If importing the certificate automatically proceed to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PerformDebuggerInstallation" title="Perform Installation" >}}

If the certificate has previously been imported you must {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyName" title="assign a friendly name" >}}.{{% /alert %}} - -To import the certificate manually follow the below steps: - -1. Locate the certificate file on the machine and right-click on the file. -1. Select `Install Certificate`. -1. Follow the Wizard and when prompted, ensure you import it into the `Local Machine` store and not `Current User`. -1. Assign the imported certificate a [friendly name][Assign Certificate Friendly Name]. - -#### Assign Certificate Friendly Name - -Once the certificate has been imported, a `Friendly Name` should be assigned which will be used in the [Configure {{% ctx %}} Gateway Installation Script][Configure CORTEX Gateway Installation Script] to enable the installation script to identify the certificate to be used for the website: - -1. Click the Windows button (`Start`). -1. Type `certlm.msc` and press `Enter` to open the Certificate Manager dialog. -1. Expand `Personal` and select `Certificates`. -1. You should see your certificate in this store. -1. Right-click on the certificate and select `Properties`. -1. On the `General` tab in the `Friendly Name` text box, enter a name to be used for the certificate. -1. Click `OK`. - -## Perform Debugger Installation - -{{% alert title="Important" color="warning" %}} -{{< ctx >}} Gateway requires a local instance of the Application Server components to enable the debugging of flows. -{{% /alert %}} - -### Install Debugger - - -To install the components required for debugging, perform the steps detailed in [Install Application Server][] on the Web Application Server. - ## Perform Gateway Installation ### Configure {{% ctx %}} Gateway Installation Script @@ -263,75 +108,21 @@ To install the components required for debugging, perform the steps detailed in ### Grant additional folder permissions to the {{% ctx %}} Gateway Application Pool User -#### Cortex Blocks Provider Host folder - -Check that the {{% ctx %}} Gateway `Application Pool` user has rights to the `Cortex Blocks Provider Host folder` folder using the following steps: - -1. Navigate to `C:\ProgramData\Cortex` -1. Right-click on the `Cortex Blocks Provider Host` folder and click `Properties`. -1. In the dialog, click the `Security` tab. -1. Check the `Application Pool` user for Gateway is listed in the `Group or user names` and has `Modify` permissions. -1. If the `Application Pool` user for Gateway is not listed: - 1. Click the `Edit...` button. - 1. Click the `Add...` button. - 1. Enter the username of the application pool user and click `OK`. - 1. In the `Permissions` section at the bottom, check `Modify`. - 1. Click `OK`. -1. If the `Application Pool` user for Gateway is listed but does not have permissions: - 1. Click the `Edit...` button. - 1. Select the `Application Pool` user. - 1. Check `Modify`. - 1. Click `OK`. - -#### Repo folder - -Check that the {{% ctx %}} Gateway `Application Pool` user has rights to the `Repo` folder using the following steps: - -1. Check where the `Repo` folder is located - 1. Navigate to the `gateway` IIS folder (usually `%SystemDrive%\inetpub\wwwroot\Cortex\gateway`, e.g. `C:\inetpub\wwwroot\Cortex\gateway`) - 1. Open the `web.config` file. - 1. Find the value of the `connectionString` named `CortexRepositories` -1. Navigate to the `Repo` folder, not opening it. -1. Right-click on the `Repo` folder and click `Properties`. -1. In the dialog, click the `Security` tab. -1. Check the `Application Pool` user for Gateway is listed in the `Group or user names` and has `Modify` permissions. -1. If the `Application Pool` user for Gateway is not listed: - 1. Click the `Edit...` button. - 1. Click the `Add...` button. - 1. Enter the username of the application pool user and click `OK`. - 1. In the `Permissions` section at the bottom, check `Modify`. - 1. Click `OK`. -1. If the `Application Pool` user for Gateway is listed but does not have permissions: - 1. Click the `Edit...` button. - 1. Select the `Application Pool` user. - 1. Check `Modify`. - 1. Click `OK`. - -#### Perform an IIS reset - -1. Open a Windows PowerShell (x64) window as administrator. -1. Run the following command: `iisreset`. -1. Wait for the action to complete. - -## Preserve installation files - -Ensure that the installation files are backed up or kept on the server, especially the scripts and config files that have been modified. This will make it easier to perform further actions in future, such as troubleshooting, certificate rollover, uninstallation, reinstallation and updates. +{{< section "/install-web-application-server/grant-gateway-user-additional-folder-permissions.md">}} ## Next Steps? -1. [Setup {{% ctx %}} Gateway][Setup CORTEX Gateway] +1. [Perform Debugger Installation][] [Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} -[Configure CORTEX Gateway Installation Script]: {{< ref "#configure-cortex-gateway-installation-script" >}} [Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScript" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} [Get CORTEX Gateway Application Pool User]: {{< ref "#get-cortex-gateway-application-pool-user" >}} [Import Certificate Manually]: {{< ref "#import-certificate-manually" >}} [Import Root Certificate]: {{< ref path="#import-root-certificate" >}} +[Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallApplicationServer" >}} [Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} -[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.LicensingRequirements" >}} [Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} -[Setup CORTEX Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.SetupGateway" >}} -[Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallApplicationServer" >}} +[Perform Debugger Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.DebuggerInstallation" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md new file mode 100644 index 000000000..9ec4d344d --- /dev/null +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md @@ -0,0 +1,126 @@ +--- +title: "Prerequisites" +linkTitle: "Prerequisites" +description: "Information about performing the prerequisities for the Web Application Server." +weight: 10 +--- + +# {{% param title %}} + +This guide describes how to install the Web Application Server. Please ensure that [Install Application Servers and Load Balancer][] has been completed before starting this installation. + +## Make Installation Artefacts Available + +{{% alert title="Note" %}} +We recommend that the single-node Service Fabric instance, used by {{% ctx %}} Gateway as a Debugger instance, and {{% ctx %}} Gateway are installed on the same Web Application Server. +{{% /alert %}} + +{{< section "/install-web-application-server/make-installation-artefacts-available.md">}} + +## Licensing + +{{< section "/install-web-application-server/add-innovation-only/licensing.md">}} + +## Install SQL Server or SQL Express + +1. Use one of the following installation guides to install SQL Server or SQL Server Express: + + * {{% ctx %}} Innovation - SQL Server 2016 Express Installation Guide + * {{% ctx %}} Innovation - SQL Server 2016 Installation Guide + * {{% ctx %}} Innovation - SQL Server 2019 Installation Guide + +## Get {{% ctx %}} Gateway Application Pool User + +A domain user account is required for the {{% ctx %}} Gateway application pool and must be created prior to performing the installation below. + +This user account is required to enable {{% ctx %}} Gateway to access the {{% ctx %}} database, with the following roles: + +* dbcreator +* public + +To add roles to database users take the following steps: + +1. Open SQL Server Management Studio on the Web Application Server and log in. +1. Expand the server node, then `Security` then `Logins`. +1. If the user that will run the {{% ctx %}} Gateway application pool is not in the list of logins, take the following steps, otherwise skip to step 4: + + 1. Right-click the `Logins` node and click `New Login...`. + 1. Enter the application pool user in the `Login name` box. + 1. On the left pane, click `Server Roles`. + 1. Check `public` and `dbcreator` + 1. Click `OK`. + +1. If the user that will run the {{% ctx %}} Gateway application pool is in the list of logins, take the following steps: + + 1. Right-click on the application pool user. + 1. Click `Properties`. + 1. On the left pane, click `Server Roles`. + 1. Check `public` and `dbcreator`. + 1. Click `OK`. + +In line with best practices, this account should not be given administrator rights, nor should it be used for any purposes other than those specified for {{% ctx %}} Gateway. + +## Grant folder permissions to the {{% ctx %}} Gateway Application Pool User + +{{< section "/install-web-application-server/grant-gateway-user-folder-permissions.md">}} + +## Certificate Requirements + +{{% ctx %}} Gateway requires an X.509 SSL certificate to be installed on the Web Application Server. The certificate must have the following properties: + +* Enhanced Key Usage: `Server Authentication` and `Client Authentication` +* Subject Alternative Names (SAN): At minimum the FQDN of the server. It can also include NetBIOS Name, IP address, localhost, 127.0.0.1 + +If the user tries to navigate to an address not in the SAN list, then they will receive a certificate error. + +{{% alert title="Important" color="warning" %}} +Do not reuse any auto-generated self-signed certificates as they do not meet the requirements for Gateway. +
+Certificates, wildcard certificates and manually created self-signed certificates can be used. However, the latter are not recommended for production instances. +Details on how to create a self-signed certificate can be found at {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.CreateSelfSignedCertificates" title="Create Self-Signed Certificates" >}}. +
+It is possible to reuse the certificate used when {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PerformDebuggerInstallation" title="installing the Debugger" >}}, as long as it is not an auto-generated self-signed certificate; If doing so, you should {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyName" title="Assign a Certificate Friendly Name" >}} and set the `ImportCertificate` parameter to `$false` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScript" title="Configure CORTEX Gateway Installation Script" >}} to ensure use of the correct certificate and to prevent it from being overwritten. +{{% /alert %}} + +### Import Root Certificate + +{{% alert title="Note" %}}This step is only required if using a self-signed certificate signed by your own Root Certificate e.g. OpenSSL. If this is not the case proceed to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ImportCertificateManually" title="Import Certificate Manually" >}} {{% /alert %}} + +This step must be carried out prior to the installation otherwise the URL validation will fail. In order to import the Root Certificate, ensure that the file is in a known location on this server and complete the following steps: + +1. Using Windows File Explorer navigate to the location of the Root Certificate file. +1. Double click on the Root Certificate file to import the certificate into the Windows Certificate Store. Perform the following steps: + + 1. Select `Local Machine` then click `Next`. + 1. Click `Next`. + 1. Enter the Export Password which the certificate was generated with then click `Next`. + 1. Select `Place all certificates in the following store`. + 1. Click `Browse…`. + 1. Select `Trusted Root Certification Authorities`, click `OK` then click `Next`. + 1. Click `Finish`. + 1. [Import][Import Certificate Manually] the X.509 SSL certificate. + +### Import Certificate Manually + +{{% alert title="Note" %}}The certificate can be imported automatically by setting the `ImportCertificate` parameter to `$true` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScript" title="Configure CORTEX Gateway Installation Script" >}}. If importing the certificate automatically proceed to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PerformDebuggerInstallation" title="Perform Installation" >}}

If the certificate has previously been imported you must {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyName" title="assign a friendly name" >}}.{{% /alert %}} + +To import the certificate manually follow the below steps: + +1. Locate the certificate file on the machine and right-click on the file. +1. Select `Install Certificate`. +1. Follow the Wizard and when prompted, ensure you import it into the `Local Machine` store and not `Current User`. +1. Assign the imported certificate a [friendly name][Assign Certificate Friendly Name]. + +### Assign Certificate Friendly Name + +{{< section "/install-web-application-server/assign-certificate-friendly-name.md">}} + +## Next Steps? + +1. [Perform Gateway Installation][] + +[Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} +[Import Certificate Manually]: {{< ref "#import-certificate-manually" >}} +[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} +[Perform Gateway Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GatewayInstallation" >}} +[Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites.md index b09639bb0..ebb519ed4 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites.md @@ -271,24 +271,24 @@ Innovation has a [gobetween][] load balancer included that isn't highly availabl 1. [Install Application Servers and Load Balancer][] -[Port Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.PortRequirements" >}} -[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} -[Installing Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScript" >}} +[alternative load balancer]: {{< ref "#alternative-load-balancer-requirements" >}} +[Anycast]: {{< url path="Anycast.MainDoc" >}} [Architecture]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Architecture" >}} +[C++ Redistributable]: {{< url path="MSDownload.CPlusPlusRedistributable.2013" >}} [Create Self-Signed Certificates]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.CreateSelfSignedCertificates" >}} -[SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} -[TriggersService]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.TriggersService.MainDoc" >}} -[gobetween]: {{< url path="GoBetween.MainDoc" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} -[Anycast]: {{< url path="Anycast.MainDoc" >}} -[alternative load balancer]: {{< ref "#alternative-load-balancer-requirements" >}} +[gobetween]: {{< url path="GoBetween.MainDoc" >}} +[IIS Url Rewrite]: {{< url path="IIS.Downloads.UrlRewrite-2_1" >}} +[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} +[Installing Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} [Microsoft Server 2019]: {{< url path="MSEval.WindowsServer.2019" >}} [Microsoft Server 2022]: {{< url path="MSEval.WindowsServer.2022" >}} -[NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}} -[Microsoft SQL Server 2019]: {{< url path="MSEval.SQLServer.2019" >}} -[Microsoft SQL Server 2016]: {{< url path="MSEval.SQLServer.2016" >}} [Microsoft SQL Express 2016]: {{< url path="MSDownload.SqlServerExpress.2016" >}} -[IIS Url Rewrite]: {{< url path="IIS.Downloads.UrlRewrite-2_1" >}} -[Web Deploy]: {{< url path="MSDownload.WebDeploy" >}} -[C++ Redistributable]: {{< url path="MSDownload.CPlusPlusRedistributable.2013" >}} +[Microsoft SQL Server 2016]: {{< url path="MSEval.SQLServer.2016" >}} +[Microsoft SQL Server 2019]: {{< url path="MSEval.SQLServer.2019" >}} +[NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}} +[Port Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.PortRequirements" >}} +[SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} [Transparent Data Encryption]: {{< url path="MSDocs.SqlServer.TransparentDataEncryption" >}} +[TriggersService]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.TriggersService.MainDoc" >}} +[Web Deploy]: {{< url path="MSDownload.WebDeploy" >}} diff --git a/data/urls.toml b/data/urls.toml index fe64ab68a..ce2bd3aec 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -99,6 +99,8 @@ InstallApplicationAndLoadBalancerServers = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers" ConfigureInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers#configure-installation-script" ConfigureCortexGatewayInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#configure-cortex-gateway-installation-script" + ConfigureCortexGatewayInstallationScriptNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation/#configure-cortex-gateway-installation-script" + ConfigureFlowDebuggerInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation/#configure-installation-script" RunInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers#run-installation-script" InstallWebApplicationServer = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server" AssignCertificateFriendlyName = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#assign-certificate-friendly-name" @@ -106,6 +108,8 @@ InstallGateway = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#install-gateway" PerformInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#perform-installation" PerformDebuggerInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#perform-debugger-installation" + DebuggerInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation" + GatewayInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation" Prerequisites = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites" AltLoadBalancer = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#alternative-load-balancer-requirements" CertificateRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#certificate-requirements" From 6c52b34e6af9195a674fb7c71e9d56de314ddadc Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Fri, 3 Nov 2023 12:53:16 +0000 Subject: [PATCH 04/21] continued making changes for debugger installation instructions --- .../assign-certificate-friendly-name.md | 2 +- .../assign-certificate-friendly-name.md | 11 +++++++ .../install-web-application-server.md | 2 +- ...ll-application-and-loadbalancer-servers.md | 7 ++--- .../perform-debugger-installation.md | 31 +++++++++---------- .../perform-gateway-installation.md | 11 ++++--- .../prerequisites.md | 21 ++++++------- data/urls.toml | 3 ++ 8 files changed, 50 insertions(+), 38 deletions(-) rename content/en/docs/2023.11/_shared/install-web-application-server/{ => add-innovation-only}/assign-certificate-friendly-name.md (78%) create mode 100644 content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/assign-certificate-friendly-name.md diff --git a/content/en/docs/2023.11/_shared/install-web-application-server/assign-certificate-friendly-name.md b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/assign-certificate-friendly-name.md similarity index 78% rename from content/en/docs/2023.11/_shared/install-web-application-server/assign-certificate-friendly-name.md rename to content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/assign-certificate-friendly-name.md index f68eafd71..36dd1b3f6 100644 --- a/content/en/docs/2023.11/_shared/install-web-application-server/assign-certificate-friendly-name.md +++ b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/assign-certificate-friendly-name.md @@ -8,4 +8,4 @@ Once the certificate has been imported, a `Friendly Name` should be assigned whi 1. On the `General` tab in the `Friendly Name` text box, enter a name to be used for the certificate. 1. Click `OK`. -[Configure CORTEX Gateway Installation Script]: {{< ref "#configure-cortex-gateway-installation-script" >}} +[Configure CORTEX Gateway Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} diff --git a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/assign-certificate-friendly-name.md b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/assign-certificate-friendly-name.md new file mode 100644 index 000000000..36dd1b3f6 --- /dev/null +++ b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/assign-certificate-friendly-name.md @@ -0,0 +1,11 @@ +Once the certificate has been imported, a `Friendly Name` should be assigned which will be used in the [Configure {{% ctx %}} Gateway Installation Script][Configure CORTEX Gateway Installation Script] to enable the installation script to identify the certificate to be used for the website: + +1. Click the Windows button (`Start`). +1. Type `certlm.msc` and press `Enter` to open the Certificate Manager dialog. +1. Expand `Personal` and select `Certificates`. +1. You should see your certificate in this store. +1. Right-click on the certificate and select `Properties`. +1. On the `General` tab in the `Friendly Name` text box, enter a name to be used for the certificate. +1. Click `OK`. + +[Configure CORTEX Gateway Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server.md index 2327a2220..bc9595006 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server.md @@ -38,7 +38,7 @@ In order to ensure that the correct certificate is used during the upgrade of {{ #### Assign Certificate Friendly Name -{{< section "/install-web-application-server/assign-certificate-friendly-name.md">}} +{{< section "/install-web-application-server/add-innovation-to-7.2/assign-certificate-friendly-name.md">}} ## Perform Debugger Installation diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers.md index 259dc4961..54ccbee69 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers.md @@ -220,8 +220,8 @@ To check all necessary ports are free, follow these steps. |----------------------------------------------|-------------| |`AppServicesPath` | Configure this value with the location of the Application Services zip file on the Application Server used for installation. | |`BlockPackagesPath` | Configure this value with the location of the Block Packages zip file on the Application Server used for installation. | - |`ApiGatewayBasicAuthUsername` | Configure this value with a username that can be used to make HTTPS requests to the API Gateway Service using Basic Authentication (e.g. starting flows). This username will be used by Gateway for all HTTPS requests to the API Gateway Service.

For security reasons it is recommended that the default value `BasicAuthUser` should be changed.

This value will be needed later, [when installing the Flow Debugger][Install Debugger] and [when installing Gateway][Install Gateway].

This username can also be used by external services for HTTPS requests to the API Gateway Service but is not recommended; these requests should use an OAuth2 session for an authorised Active Directory user.| - |`ApiGatewayBasicAuthPassword` | Configure this value with the password for the username specified for `ApiGatewayBasicAuthUsername`.

This password should be [{{% ctx %}} Encrypted][CORTEX Encrypted]. For security reasons it is recommended that the default value `ADA9883B11BD4CDC908B8131B57944A4` should be changed.

This value will be needed later, [when installing the Flow Debugger][Install Debugger] and [when installing Gateway][Install Gateway].| + |`ApiGatewayBasicAuthUsername` | Configure this value with a username that can be used to make HTTPS requests to the API Gateway Service using Basic Authentication (e.g. starting flows). This username will be used by Gateway for all HTTPS requests to the API Gateway Service.

For security reasons it is recommended that the default value `BasicAuthUser` should be changed.

This value will be needed later, [when installing Gateway][Install Gateway].

This username can also be used by external services for HTTPS requests to the API Gateway Service but is not recommended; these requests should use an OAuth2 session for an authorised Active Directory user.| + |`ApiGatewayBasicAuthPassword` | Configure this value with the password for the username specified for `ApiGatewayBasicAuthUsername`.

This password should be [{{% ctx %}} Encrypted][CORTEX Encrypted]. For security reasons it is recommended that the default value `ADA9883B11BD4CDC908B8131B57944A4` should be changed.

This value will be needed later, [when installing Gateway][Install Gateway].| |`CustomerName` | A name identifying the platform being installed. This must have no spaces or symbols. It will be appended to the node names that are displayed in Service Fabric Explorer. | |`ApplicationServerIPv4Addresses` | The IPv4 addresses of the Application Servers. The first of these must be the Application Server used for installation. | |`LoadBalancerServerIPv4Address` | The IPv4 address of the Load Balancer Server. This is only needed if using the built-in load balancer. | @@ -236,7 +236,7 @@ To check all necessary ports are free, follow these steps. |`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. | |`FilePath` | The filename that installation logs are written to. If this should be written to a different location than where the installation files are then a full path should be specified. | - The `ApiGatewayBasicAuthUsername` and `ApiGatewayBasicAuthPassword` will be needed [later, when installing Gateway][Install Gateway]. + The `ApiGatewayBasicAuthUsername` and `ApiGatewayBasicAuthPassword` will be needed later, [when installing Gateway][Install Gateway]. {{% alert title="Note" %}} More advanced configuration (such as changing ports) can be undertaken by modifying the `Cortex.Innovation.Install.Config.json` file but this shouldn't be required for most installations. More information about this can be found at {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.AdvancedConfigMultipleServer" title="Advanced Application Server and Load Balancer Configuration Changes" >}}. @@ -322,7 +322,6 @@ More advanced configuration (such as changing ports) can be undertaken by modify [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} -[Install Debugger]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureFlowDebuggerInstallationScript" >}} [Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} [Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallWebApplicationServer" >}} [NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md index 38cec0a09..cc2337f0a 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md @@ -1,55 +1,53 @@ --- -title: "Perform Debugger Installation" -linkTitle: "Perform Debugger Installation" +title: "Perform Flow Debugger Installation" +linkTitle: "Perform Flow Debugger Installation" description: "Information about installing the Flow Debugger." -weight: 30 +weight: 20 --- # {{% param title %}} -This guide describes how to install the Web Application Server. Please ensure that [Install Application Servers and Load Balancer][] has been completed before starting this installation. - -## Perform Debugger Installation +This guide describes how to install the Flow Debugger on the Web Application Server. Please ensure that the [web application server prerequisites][] have been completed before starting this installation. {{% alert title="Important" color="warning" %}} {{< ctx >}} Gateway requires a local instance of the Application Server components to enable the debugging of flows. {{% /alert %}} -### Add Antivirus Exclusions +## Add Antivirus Exclusions {{< section "/install-application-server/single-server/add-antivirus-exclusions.md">}} -### Check Port Usage +## Check Port Usage {{< section "/install-application-server/single-server/check-port-useage.md">}} -### Configure Installation Script +## Configure Installation Script {{< section "/install-application-server/single-server/add-innovation-only/configure-installation-script.md">}} -### Test Installation Script +## Test Installation Script {{< section "/install-application-server/single-server/test-installation-script.md">}} -### Run Installation Script +## Run Installation Script {{< section "/install-application-server/single-server/run-installation-script.md">}} -### Add Read and Execute access to Windows Crypto folder +## Add Read and Execute access to Windows Crypto folder {{< section "/install-application-server/single-server/add-permissions-to-crypto-folder.md">}} -### Check Application Services +## Check Application Services {{< section "/install-application-server/single-server/check-application-services.md">}} -## Preserve installation files +# Preserve installation files {{< section "/preserve-installation-files.md">}} ## Next Steps? -1. [Setup {{% ctx %}} Gateway][Setup CORTEX Gateway] +1. [Perform Gateway Installation][] [Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} @@ -61,5 +59,6 @@ This guide describes how to install the Web Application Server. Please ensure th [Import Root Certificate]: {{< ref path="#import-root-certificate" >}} [Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallApplicationServer" >}} [Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} +[Perform Gateway Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GatewayInstallation" >}} [Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} -[Setup CORTEX Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.SetupGateway" >}} +[web application server prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.WebApplicationServerPrerequisites" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md index e5f4f7995..1a1d64655 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md @@ -2,12 +2,12 @@ title: "Perform Gateway Installation" linkTitle: "Perform Gateway Installation" description: "Information about installing {{% ctx %}} Gateway." -weight: 20 +weight: 30 --- # {{% param title %}} -This guide describes how to install the Web Application Server. Please ensure that [Install Application Servers and Load Balancer][] has been completed before starting this installation. +This guide describes how to install {{% ctx %}} Gateway on the Web Application Server. Please ensure that the [Flow Debugger installation][] has been completed before starting this installation. ## Perform Gateway Installation @@ -112,17 +112,18 @@ This guide describes how to install the Web Application Server. Please ensure th ## Next Steps? -1. [Perform Debugger Installation][] +1. [Setup {{% ctx %}} Gateway][Setup CORTEX Gateway] [Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} [Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScript" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} +[Flow Debugger installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.DebuggerInstallation" >}} [Get CORTEX Gateway Application Pool User]: {{< ref "#get-cortex-gateway-application-pool-user" >}} [Import Certificate Manually]: {{< ref "#import-certificate-manually" >}} [Import Root Certificate]: {{< ref path="#import-root-certificate" >}} [Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallApplicationServer" >}} -[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} +[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.LicensingRequirements" >}} [Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} -[Perform Debugger Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.DebuggerInstallation" >}} +[Setup CORTEX Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.SetupGateway" >}} \ No newline at end of file diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md index 9ec4d344d..e3c20ddfa 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md @@ -23,11 +23,11 @@ We recommend that the single-node Service Fabric instance, used by {{% ctx %}} G ## Install SQL Server or SQL Express -1. Use one of the following installation guides to install SQL Server or SQL Server Express: +Use one of the following installation guides to install SQL Server or SQL Server Express: - * {{% ctx %}} Innovation - SQL Server 2016 Express Installation Guide - * {{% ctx %}} Innovation - SQL Server 2016 Installation Guide - * {{% ctx %}} Innovation - SQL Server 2019 Installation Guide +* {{% ctx %}} Innovation - SQL Server 2016 Express Installation Guide +* {{% ctx %}} Innovation - SQL Server 2016 Installation Guide +* {{% ctx %}} Innovation - SQL Server 2019 Installation Guide ## Get {{% ctx %}} Gateway Application Pool User @@ -79,12 +79,12 @@ Do not reuse any auto-generated self-signed certificates as they do not meet the Certificates, wildcard certificates and manually created self-signed certificates can be used. However, the latter are not recommended for production instances. Details on how to create a self-signed certificate can be found at {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.CreateSelfSignedCertificates" title="Create Self-Signed Certificates" >}}.
-It is possible to reuse the certificate used when {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PerformDebuggerInstallation" title="installing the Debugger" >}}, as long as it is not an auto-generated self-signed certificate; If doing so, you should {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyName" title="Assign a Certificate Friendly Name" >}} and set the `ImportCertificate` parameter to `$false` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScript" title="Configure CORTEX Gateway Installation Script" >}} to ensure use of the correct certificate and to prevent it from being overwritten. +It is possible to reuse the certificate used when {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.DebuggerInstallation" title="installing the Debugger" >}}, as long as it is not an auto-generated self-signed certificate; If doing so, you should {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyNameNew" title="Assign a Certificate Friendly Name" >}} and set the `ImportCertificate` parameter to `$false` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" title="Configure CORTEX Gateway Installation Script" >}} to ensure use of the correct certificate and to prevent it from being overwritten. {{% /alert %}} ### Import Root Certificate -{{% alert title="Note" %}}This step is only required if using a self-signed certificate signed by your own Root Certificate e.g. OpenSSL. If this is not the case proceed to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ImportCertificateManually" title="Import Certificate Manually" >}} {{% /alert %}} +{{% alert title="Note" %}}This step is only required if using a self-signed certificate signed by your own Root Certificate e.g. OpenSSL. If this is not the case proceed to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ImportCertificateManuallyNew" title="Import Certificate Manually" >}} {{% /alert %}} This step must be carried out prior to the installation otherwise the URL validation will fail. In order to import the Root Certificate, ensure that the file is in a known location on this server and complete the following steps: @@ -102,7 +102,7 @@ This step must be carried out prior to the installation otherwise the URL valida ### Import Certificate Manually -{{% alert title="Note" %}}The certificate can be imported automatically by setting the `ImportCertificate` parameter to `$true` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScript" title="Configure CORTEX Gateway Installation Script" >}}. If importing the certificate automatically proceed to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PerformDebuggerInstallation" title="Perform Installation" >}}

If the certificate has previously been imported you must {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyName" title="assign a friendly name" >}}.{{% /alert %}} +{{% alert title="Note" %}}The certificate can be imported automatically by setting the `ImportCertificate` parameter to `$true` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" title="Configure CORTEX Gateway Installation Script" >}}. If importing the certificate automatically proceed to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GatewayInstallation" title="Perform {{% ctx %}} Gateway Installation" >}}

If the certificate has previously been imported you must {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyNameNew" title="assign a friendly name" >}}.{{% /alert %}} To import the certificate manually follow the below steps: @@ -113,14 +113,13 @@ To import the certificate manually follow the below steps: ### Assign Certificate Friendly Name -{{< section "/install-web-application-server/assign-certificate-friendly-name.md">}} +{{< section "/install-web-application-server/add-innovation-only/assign-certificate-friendly-name.md">}} ## Next Steps? -1. [Perform Gateway Installation][] +1. [Perform Flow Debugger Installation][] [Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} [Import Certificate Manually]: {{< ref "#import-certificate-manually" >}} [Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} -[Perform Gateway Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GatewayInstallation" >}} -[Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} +[Perform Flow Debugger Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.DebuggerInstallation" >}} diff --git a/data/urls.toml b/data/urls.toml index ce2bd3aec..630d87b46 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -104,7 +104,9 @@ RunInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers#run-installation-script" InstallWebApplicationServer = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server" AssignCertificateFriendlyName = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#assign-certificate-friendly-name" + AssignCertificateFriendlyNameNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites/#assign-certificate-friendly-name" ImportCertificateManually = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#import-certificate-manually" + ImportCertificateManuallyNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites/#import-certificate-manually" InstallGateway = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#install-gateway" PerformInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#perform-installation" PerformDebuggerInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#perform-debugger-installation" @@ -113,6 +115,7 @@ Prerequisites = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites" AltLoadBalancer = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#alternative-load-balancer-requirements" CertificateRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#certificate-requirements" + WebApplicationServerPrerequisites = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites" WebBrowserRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#web-browser-requirements" AntivirusExclusions = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#antivirus-exclusions" LicensingRequirements = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/prerequisites#licensing-requirements" From 0e681721108fd733592dd6951949ea68392085a2 Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Thu, 9 Nov 2023 12:25:45 +0000 Subject: [PATCH 05/21] Finalised changhes to Innovation Only Multi Server Web App Install instructions --- .../single-server/add-antivirus-exclusions.md | 25 +- .../configure-debugger-installation-script.md | 75 +++++ .../install-application-server.md | 3 + .../perform-debugger-installation.md | 9 +- .../perform-gateway-installation.md | 13 +- .../multiple-server-with-ha/setup-gateway.md | 4 +- .../install-application-server.md | 3 + data/urls.toml | 2 + package-lock.json | 307 ++++++++++-------- 9 files changed, 276 insertions(+), 165 deletions(-) create mode 100644 content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md diff --git a/content/en/docs/2023.11/_shared/install-application-server/single-server/add-antivirus-exclusions.md b/content/en/docs/2023.11/_shared/install-application-server/single-server/add-antivirus-exclusions.md index 0fa01386f..6596c4aa1 100644 --- a/content/en/docs/2023.11/_shared/install-application-server/single-server/add-antivirus-exclusions.md +++ b/content/en/docs/2023.11/_shared/install-application-server/single-server/add-antivirus-exclusions.md @@ -1,18 +1,15 @@ -1. If Windows Defender is not running on the server, ensure that the [Antivirus Exclusions][] have been added to the running antivirus software on the server and continue to the next section, otherwise follow these steps: - 1. Open a Windows PowerShell (x64) window as administrator. - 1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: +1. Open a Windows PowerShell (x64) window as administrator. +1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: - ```powershell - cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" - ``` + ```powershell + cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" + ``` - 1. Run the `Cortex.Innovation.Add.WindowsDefenderExclusions.ps1` script using the following command, modifying the `ApplicationServers` value to contain the NETBIOS name or fully qualified domain name of the server: +1. Run the `Cortex.Innovation.Add.WindowsDefenderExclusions.ps1` script using the following command, modifying the `ApplicationServers` value to contain the NETBIOS name or fully qualified domain name of the server: - ```powershell - .\Cortex.Innovation.Add.WindowsDefenderExclusions.ps1 -ApplicationServers @("app-server1") - ``` + ```powershell + .\Cortex.Innovation.Add.WindowsDefenderExclusions.ps1 -ApplicationServers @("app-server1") + ``` - 1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK. - 1. A message will indicate that the script has completed successfully. - -[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.AntivirusExclusions" >}} \ No newline at end of file +1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK. +1. A message will indicate that the script has completed successfully. diff --git a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md new file mode 100644 index 000000000..166d4c918 --- /dev/null +++ b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md @@ -0,0 +1,75 @@ +1. In the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder, locate the `Cortex.Innovation.Install.ps1` script and open it with a text editor. +1. Choose the tab below that matches the configuration for this installation, then update the script to match, changing the parameters according to the details given below: + + {{< tabpane lang="powershell" >}} + {{< tab header="CA Certs" >}} +.\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` + -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` + -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` + -ApiGatewayBasicAuthUsername "BasicAuthUser" ` + -ApiGatewayBasicAuthPassword "ADA9883B11BD4CDC908B8131B57944A4" ` + -CustomerName "Customer1" ` + -ApplicationServerIPv4Addresses @("192.168.1.1") ` + -ServerCertificatePath "C:\Install\Certificates\cert.pfx" ` + -ServerCertificatePassword "myPassword" ` + -SkipLoadBalancer ` + -Credential $Credential ` + -LdapConnectionDetails @{ + Host= "LDAP://ldapserver.fqdn.com:389" + UseSsl= $false + Username= "someUserName" + Password= "somePassword" + } ` + -AcceptEULA:$AcceptEula ` + *>&1 | Tee-Object -FilePath "cortex-app-install-log.txt" + {{< /tab >}} + {{< tab header="Self-Signed Certs" >}} +.\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` + -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` + -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` + -ApiGatewayBasicAuthUsername "BasicAuthUser" ` + -ApiGatewayBasicAuthPassword "ADA9883B11BD4CDC908B8131B57944A4" ` + -CustomerName "Customer1" ` + -ApplicationServerIPv4Addresses @("192.168.1.1") ` + -UseSelfSignedCertificates ` + -SkipLoadBalancer ` + -Credential $Credential ` + -LdapConnectionDetails @{ + Host= "LDAP://ldapserver.fqdn.com:389" + UseSsl= $false + Username= "someUserName" + Password= "somePassword" + } ` + -AcceptEULA:$AcceptEula ` + *>&1 | Tee-Object -FilePath "cortex-app-install-log.txt" + {{< /tab >}} + {{< /tabpane >}} + + | Name | Description | + |----------------------------------------------|-------------| + |`AppServicesPath` | Configure this value with the location of the App Services zip file on the server. | + |`BlockPackagesPath` | Configure this value with the location of the Block Packages zip file on the server. | + |`ApiGatewayBasicAuthUsername` | Configure this value with a username that can be used to make HTTPS requests to the API Gateway Service using Basic Authentication (e.g. starting flows). This username will be used by Gateway for all HTTPS requests to the API Gateway Service.

For security reasons it is recommended that the default value `BasicAuthUser` should be changed.

This value will be needed [later, when installing Gateway][Install Gateway].

This username can also be used by external services for HTTPS requests to the API Gateway Service but is not recommended; these requests should use an OAuth2 session for an authorised Active Directory user.| + |`ApiGatewayBasicAuthPassword` | Configure this value with the password for the username specified for `ApiGatewayBasicAuthUsername`.

This password should be [{{% ctx %}} Encrypted][CORTEX Encrypted]. For security reasons it is recommended that the default value `ADA9883B11BD4CDC908B8131B57944A4` should be changed.

This value will be needed [later, when installing Gateway][Install Gateway].| + |`CustomerName` | A name identifying the platform being installed. This must have no spaces or symbols. It will be appended to the node names that are displayed in Service Fabric Explorer. | + |`ApplicationServerIPv4Addresses` | The IPv4 address of the server.| + |`ServerCertificatePath` | The local path of a .PFX certificate file on the server. Environment variables cannot be used.

This is only needed if installing with CA Certificates (Recommended). The certificate should meet the [Certificate Requirements][].

This certificate will be used for:
  • Securing communication between the Application Services.
  • Allowing Application Services to identify themselves to clients such as Gateway.
  • Preventing unauthorised nodes from joining the single node cluster.
  • Connecting to Service Fabric Explorer from each of the Application Servers.
{{< alert type="warning" title="Warning" >}}It is critical to set a reminder to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.RolloverCertificates" title="update certificates" >}} in good time before they expire. If they expire then the platform will cease to function and {{< ahref path="Cortex.ServicePortal.MainDoc" title="CORTEX Service Portal" >}} must be contacted for support.{{< /alert >}}| + |`ServerCertificatePassword` | The password for the .PFX certificate file specified in `ServerCertificatePath`.

This is only needed if installing with CA Certificates (Recommended).| + |`UseSelfSignedCertificates` | Installs Application Services and required infrastructure using generated Self-Signed Certificates rather than CA Certificates.

Not recommended for production use. | + |`SkipLoadBalancer` | Installs Application Services and required infrastructure without installing a load balancer. | + |`Credential` | The credentials of the user which will be used to perform remote operations on the server. It must be a domain user that is a member of the local Administrators group on the server.

This does not need to be changed, a prompt will appear to enter this information when the script is run. | + |`LdapConnectionDetails` | The connection details to the LDAP server.

This must be configured with a valid `Host`, `Username`, `Password`, and whether the LDAP server uses SSL using `UseSsl`. {{< alert type="note" title="Note" >}}All fields but `UseSsl` can be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | + |`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. | + |`FilePath` | The filename that installation logs are written to. If this should be written to a different location than where the installation files are then a full path should be specified. | + + The `ApiGatewayBasicAuthUsername` and `ApiGatewayBasicAuthPassword` will be needed [later, when installing Gateway][Install Gateway]. + + {{% alert title="Note" %}} +More advanced configuration (such as changing ports) can be undertaken by modifying the `Cortex.Innovation.Install.Config.json` file but this shouldn't be required for most installations. More information about this can be found at {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.AdvancedConfigSingleServer" title="Advanced Application Server and Load Balancer Configuration Changes" >}}. + {{% /alert %}} + +1. Save and close `Cortex.Innovation.Install.ps1`. + +[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.CertificateRequirements" >}} +[CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} +[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} \ No newline at end of file diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md index d587211a7..e3306e43b 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md @@ -23,6 +23,8 @@ This guide describes how to install the Application Server components on the ser ## Add Antivirus Exclusions +If Windows Defender is not running on the server, ensure that the [Antivirus Exclusions][] have been added to the running antivirus software on the server and continue to the next section, otherwise follow these steps: + {{< section "/install-application-server/single-server/add-antivirus-exclusions.md">}} ## Check Port Usage @@ -57,5 +59,6 @@ This guide describes how to install the Application Server components on the ser 1. [Install Web Application Server][] +[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.AntivirusExclusions" >}} [Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.AddInnovationTo72WebApplicationServer" >}} [Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.Prerequisites" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md index cc2337f0a..08291dadb 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md @@ -13,8 +13,14 @@ This guide describes how to install the Flow Debugger on the Web Application Ser {{< ctx >}} Gateway requires a local instance of the Application Server components to enable the debugging of flows. {{% /alert %}} +## Install Microsoft .NET Framework 4.7.2 + +{{< section "/install-application-server/install-dot-net-framework.md">}} + ## Add Antivirus Exclusions +If Windows Defender is not running on the server, ensure that the [Antivirus Exclusions][] have been added to the running antivirus software on the server and continue to the next section, otherwise follow these steps: + {{< section "/install-application-server/single-server/add-antivirus-exclusions.md">}} ## Check Port Usage @@ -23,7 +29,7 @@ This guide describes how to install the Flow Debugger on the Web Application Ser ## Configure Installation Script -{{< section "/install-application-server/single-server/add-innovation-only/configure-installation-script.md">}} +{{< section "/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md">}} ## Test Installation Script @@ -49,6 +55,7 @@ This guide describes how to install the Flow Debugger on the Web Application Ser 1. [Perform Gateway Installation][] +[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AntivirusExclusions" >}} [Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} [Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScript" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md index 1a1d64655..3155f3e4f 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md @@ -56,8 +56,8 @@ This guide describes how to install {{% ctx %}} Gateway on the Web Application S |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used.

This will set the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used. It can be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This will set the `ServiceFabricApiGatewayBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.| |`DotNetFlowDebuggerEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the Web Application Server.

This will set the `DotNetFlowDebuggerEndpoint` value in the {{% ctx %}} Gateway web.config.| - |`DotNetFlowDebuggerBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Debugger on the Web Application Server][Install Application Server]; if so, this value must be configured to the one used.

This will set the `DotNetFlowDebuggerBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.| - |`DotNetFlowDebuggerBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Debugger on the Web Application Server][Install Application Server]; if so, this value must be configured to the one used. It can be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This will set the `DotNetFlowDebuggerBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.| + |`DotNetFlowDebuggerBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Debugger on the Web Application Server][Flow Debugger installation]; if so, this value must be configured to the one used.

This will set the `DotNetFlowDebuggerBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.| + |`DotNetFlowDebuggerBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Debugger on the Web Application Server][Flow Debugger installation]; if so, this value must be configured to the one used. It can be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This will set the `DotNetFlowDebuggerBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.| |`DotNetFlowDebuggerUsingSelfSignedCertificates` | Configure the value as `$false` if you are using valid CA certificates to secure the communication between {{% ctx %}} Gateway and the Debugger, `$true` if using self-signed certificates.

This will set the `DotNetFlowDebuggerUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`GatewayApplicationPoolUsername` | Replace `Domain\Username` with the user that should be used to run the {{% ctx %}} Gateway application pool as configured in [Get {{% ctx %}} Gateway Application Pool User][Get CORTEX Gateway Application Pool User].| |`WebRootFolder` | Replace this with the correct path for the Web Root Folder on the server. Typically this will be `C:\inetpub\wwwroot`.| @@ -114,16 +114,15 @@ This guide describes how to install {{% ctx %}} Gateway on the Web Application S 1. [Setup {{% ctx %}} Gateway][Setup CORTEX Gateway] -[Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} +[Assign Certificate Friendly Name]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyNameNew" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} [Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScript" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} [Flow Debugger installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.DebuggerInstallation" >}} -[Get CORTEX Gateway Application Pool User]: {{< ref "#get-cortex-gateway-application-pool-user" >}} -[Import Certificate Manually]: {{< ref "#import-certificate-manually" >}} -[Import Root Certificate]: {{< ref path="#import-root-certificate" >}} -[Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallApplicationServer" >}} +[Get CORTEX Gateway Application Pool User]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GetGatewayAppPoolUser" >}} +[Import Certificate Manually]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ImportCertificateManuallyNew" >}} +[Import Root Certificate]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ImportRootCertificate" >}} [Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.LicensingRequirements" >}} [Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} [Setup CORTEX Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.SetupGateway" >}} \ No newline at end of file diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/setup-gateway.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/setup-gateway.md index 526af758e..cc61ed586 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/setup-gateway.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/setup-gateway.md @@ -7,7 +7,7 @@ weight: 50 # {{% param title %}} -This guide describes how to setup Gateway. Please ensure that [Install Web Application Server][] has been completed before taking these steps. +This guide describes how to setup Gateway. Please ensure that [Perform Gateway Installation][] has been completed before taking these steps. ## Gateway Initial Setup @@ -88,5 +88,5 @@ Once Gateway has been configured, if you wish to encrypt the databases using [Tr [Account Details]: {{< ref "#account-details" >}} [LDAP Connection]: {{< ref "#ldap-connection" >}} [LDAP Authorisation]: {{< ref "#ldap-authorisation" >}} -[Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallWebApplicationServer" >}} +[Perform Gateway Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GatewayInstallation" >}} [Transparent Data Encryption]: {{< url path="MSDocs.SqlServer.TransparentDataEncryption" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server.md index d3bb92d51..58cf4012e 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server.md @@ -23,6 +23,8 @@ This guide describes how to install the Application Server components on the ser ## Add Antivirus Exclusions +If Windows Defender is not running on the server, ensure that the [Antivirus Exclusions][] have been added to the running antivirus software on the server and continue to the next section, otherwise follow these steps: + {{< section "/install-application-server/single-server/add-antivirus-exclusions.md">}} ## Check Port Usage @@ -57,5 +59,6 @@ This guide describes how to install the Application Server components on the ser 1. [Install Web Application Server][] +[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.AntivirusExclusions" >}} [Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallWebApplicationServer" >}} [Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.Prerequisites" >}} diff --git a/data/urls.toml b/data/urls.toml index 630d87b46..ad3868ffe 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -105,8 +105,10 @@ InstallWebApplicationServer = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server" AssignCertificateFriendlyName = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#assign-certificate-friendly-name" AssignCertificateFriendlyNameNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites/#assign-certificate-friendly-name" + GetGatewayAppPoolUser = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites/#get-cortex-gateway-application-pool-user" ImportCertificateManually = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#import-certificate-manually" ImportCertificateManuallyNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites/#import-certificate-manually" + ImportRootCertificate = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites/#import-root-certificate" InstallGateway = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#install-gateway" PerformInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#perform-installation" PerformDebuggerInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#perform-debugger-installation" diff --git a/package-lock.json b/package-lock.json index 38f2f5a48..ff5a3fa56 100644 --- a/package-lock.json +++ b/package-lock.json @@ -55,9 +55,9 @@ "dev": true }, "node_modules/ansi-regex": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", - "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", "dev": true, "engines": { "node": ">=8" @@ -133,32 +133,6 @@ "autoprefixer": "bin/autoprefixer" } }, - "node_modules/autoprefixer/node_modules/postcss": { - "version": "7.0.32", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-7.0.32.tgz", - "integrity": "sha512-03eXong5NLnNCD05xscnGKGDZ98CyzoqPSMjOe6SuoQY7Z2hIj0Ld1g/O/UQRuOle2aRtiIRDg9tDcTGAkLfKw==", - "dev": true, - "dependencies": { - "chalk": "^2.4.2", - "source-map": "^0.6.1", - "supports-color": "^6.1.0" - }, - "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/autoprefixer/node_modules/supports-color": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-6.1.0.tgz", - "integrity": "sha512-qe1jfm1Mg7Nq/NSh6XE24gPXROEVsWHxC1LIx//XNlD9iw7YZQGjZNjYN7xGaEG6iKdA8EtNFW6R0gjnVXp+wQ==", - "dev": true, - "dependencies": { - "has-flag": "^3.0.0" - }, - "engines": { - "node": ">=6" - } - }, "node_modules/binary-extensions": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.1.0.tgz", @@ -181,15 +155,29 @@ } }, "node_modules/browserslist": { - "version": "4.14.0", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.14.0.tgz", - "integrity": "sha512-pUsXKAF2lVwhmtpeA3LJrZ76jXuusrNyhduuQs7CDFf9foT4Y38aQOserd2lMe5DSSrjf3fx34oHwryuvxAUgQ==", - "dev": true, + "version": "4.22.1", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.22.1.tgz", + "integrity": "sha512-FEVc202+2iuClEhZhrWy6ZiAcRLvNMyYcxZ8raemul1DYVOVdFsbqckWLdsixQZCpJlwe77Z3UTalE7jsjnKfQ==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], "dependencies": { - "caniuse-lite": "^1.0.30001111", - "electron-to-chromium": "^1.3.523", - "escalade": "^3.0.2", - "node-releases": "^1.1.60" + "caniuse-lite": "^1.0.30001541", + "electron-to-chromium": "^1.4.535", + "node-releases": "^2.0.13", + "update-browserslist-db": "^1.0.13" }, "bin": { "browserslist": "cli.js" @@ -241,10 +229,24 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001115", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001115.tgz", - "integrity": "sha512-NZrG0439ePYna44lJX8evHX2L7Z3/z3qjVLnHgbBb/duNEnGo348u+BQS5o4HTWcrb++100dHFrU36IesIrC1Q==", - "dev": true + "version": "1.0.30001561", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001561.tgz", + "integrity": "sha512-NTt0DNoKe958Q0BE0j0c1V9jbUzhBxHIEJy7asmGrpE0yG63KTV7PLHPnK2E1O9RsQrQ081I3NLuXGS6zht3cw==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/caniuse-lite" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ] }, "node_modules/chalk": { "version": "2.4.2", @@ -359,9 +361,9 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.3.534", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.534.tgz", - "integrity": "sha512-7x2S3yUrspNHQOoPk+Eo+iHViSiJiEGPI6BpmLy1eT2KRNGCkBt/NUYqjfXLd1DpDCQp7n3+LfA1RkbG+LqTZQ==", + "version": "1.4.579", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.579.tgz", + "integrity": "sha512-bJKvA+awBIzYR0xRced7PrQuRIwGQPpo6ZLP62GAShahU9fWpsNN2IP6BSP1BLDDSbxvBVRGAMWlvVVq3npmLA==", "dev": true }, "node_modules/emoji-regex": { @@ -380,9 +382,9 @@ } }, "node_modules/escalade": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.0.2.tgz", - "integrity": "sha512-gPYAU37hYCUhW5euPeR+Y74F7BL+IBsV93j5cvGriSaD1aG6MGsqsV1yamRdrWrb2j3aiZvb0X+UBOWpx3JWtQ==", + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.1.tgz", + "integrity": "sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==", "dev": true, "engines": { "node": ">=6" @@ -508,9 +510,9 @@ } }, "node_modules/glob-parent": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.1.tgz", - "integrity": "sha512-FnI+VGOpnlGHWZxthPGR+QhR78fuiK0sNLkHQv+bL9fQi57lNNdquIbna/WrfROrolq8GK5Ek6BiMwqL/voRYQ==", + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", "dev": true, "dependencies": { "is-glob": "^4.0.1" @@ -705,9 +707,9 @@ } }, "node_modules/lodash": { - "version": "4.17.20", - "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.20.tgz", - "integrity": "sha512-PlhdFcillOINfeV7Ni6oF1TAEayyZBoZ8bcshTHqOYJYlrqzRK5hagpagky5o4HfCzzd1TRkXPMFq6cKk9rGmA==", + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", "dev": true }, "node_modules/log-symbols": { @@ -745,9 +747,9 @@ } }, "node_modules/node-releases": { - "version": "1.1.60", - "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-1.1.60.tgz", - "integrity": "sha512-gsO4vjEdQaTusZAEebUWp2a5d7dF5DYoIpDG7WySnk7BuZDW+GPpHXoXXuYawRBr/9t5q54tirPz79kFIWg4dA==", + "version": "2.0.13", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.13.tgz", + "integrity": "sha512-uYr7J37ae/ORWdZeQ1xxMJe3NtdmqMC/JZK+geofDrkLUApKRHPd18/TxtBOJ4A0/+uUIliorNrfYV6s1b02eQ==", "dev": true }, "node_modules/normalize-path": { @@ -838,6 +840,12 @@ "node": ">=8" } }, + "node_modules/picocolors": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-0.2.1.tgz", + "integrity": "sha512-cMlDqaLEqfSaW8Z7N5Jw+lyIW869EzT73/F5lhtY9cLGoVxSXznfgfXMO0Z5K0o0Q2TkTXq+0KFsdnSe3jDViA==", + "dev": true + }, "node_modules/picomatch": { "version": "2.2.2", "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.2.2.tgz", @@ -857,17 +865,20 @@ } }, "node_modules/postcss": { - "version": "7.0.32", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-7.0.32.tgz", - "integrity": "sha512-03eXong5NLnNCD05xscnGKGDZ98CyzoqPSMjOe6SuoQY7Z2hIj0Ld1g/O/UQRuOle2aRtiIRDg9tDcTGAkLfKw==", + "version": "7.0.39", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-7.0.39.tgz", + "integrity": "sha512-yioayjNbHn6z1/Bywyb2Y4s3yvDAeXGOyxqD+LnVOinq6Mdmd++SW2wUNVzavyyHxd6+DxzWGIuosg6P1Rj8uA==", "dev": true, "dependencies": { - "chalk": "^2.4.2", - "source-map": "^0.6.1", - "supports-color": "^6.1.0" + "picocolors": "^0.2.1", + "source-map": "^0.6.1" }, "engines": { "node": ">=6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" } }, "node_modules/postcss-cli": { @@ -995,18 +1006,6 @@ "integrity": "sha512-97DXOFbQJhk71ne5/Mt6cOu6yxsSfM0QGQyl0L25Gca4yGWEGJaig7l7gbCX623VqTBNGLRLaVUCnNkcedlRSQ==", "dev": true }, - "node_modules/postcss/node_modules/supports-color": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-6.1.0.tgz", - "integrity": "sha512-qe1jfm1Mg7Nq/NSh6XE24gPXROEVsWHxC1LIx//XNlD9iw7YZQGjZNjYN7xGaEG6iKdA8EtNFW6R0gjnVXp+wQ==", - "dev": true, - "dependencies": { - "has-flag": "^3.0.0" - }, - "engines": { - "node": ">=6" - } - }, "node_modules/pretty-hrtime": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/pretty-hrtime/-/pretty-hrtime-1.0.3.tgz", @@ -1166,6 +1165,42 @@ "node": ">= 10.0.0" } }, + "node_modules/update-browserslist-db": { + "version": "1.0.13", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.0.13.tgz", + "integrity": "sha512-xebP81SNcPuNpPP3uzeW1NYXxI3rxyJzF3pD6sH4jE7o/IX+WtSpwnVU+qIsDPyk0d3hmFQ7mjqc6AtV604hbg==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "dependencies": { + "escalade": "^3.1.1", + "picocolors": "^1.0.0" + }, + "bin": { + "update-browserslist-db": "cli.js" + }, + "peerDependencies": { + "browserslist": ">= 4.21.0" + } + }, + "node_modules/update-browserslist-db/node_modules/picocolors": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz", + "integrity": "sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==", + "dev": true + }, "node_modules/which-module": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/which-module/-/which-module-2.0.0.tgz", @@ -1293,9 +1328,9 @@ "dev": true }, "ansi-regex": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", - "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", "dev": true }, "ansi-styles": { @@ -1351,28 +1386,6 @@ "num2fraction": "^1.2.2", "postcss": "^7.0.32", "postcss-value-parser": "^4.1.0" - }, - "dependencies": { - "postcss": { - "version": "7.0.32", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-7.0.32.tgz", - "integrity": "sha512-03eXong5NLnNCD05xscnGKGDZ98CyzoqPSMjOe6SuoQY7Z2hIj0Ld1g/O/UQRuOle2aRtiIRDg9tDcTGAkLfKw==", - "dev": true, - "requires": { - "chalk": "^2.4.2", - "source-map": "^0.6.1", - "supports-color": "^6.1.0" - } - }, - "supports-color": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-6.1.0.tgz", - "integrity": "sha512-qe1jfm1Mg7Nq/NSh6XE24gPXROEVsWHxC1LIx//XNlD9iw7YZQGjZNjYN7xGaEG6iKdA8EtNFW6R0gjnVXp+wQ==", - "dev": true, - "requires": { - "has-flag": "^3.0.0" - } - } } }, "binary-extensions": { @@ -1391,15 +1404,15 @@ } }, "browserslist": { - "version": "4.14.0", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.14.0.tgz", - "integrity": "sha512-pUsXKAF2lVwhmtpeA3LJrZ76jXuusrNyhduuQs7CDFf9foT4Y38aQOserd2lMe5DSSrjf3fx34oHwryuvxAUgQ==", + "version": "4.22.1", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.22.1.tgz", + "integrity": "sha512-FEVc202+2iuClEhZhrWy6ZiAcRLvNMyYcxZ8raemul1DYVOVdFsbqckWLdsixQZCpJlwe77Z3UTalE7jsjnKfQ==", "dev": true, "requires": { - "caniuse-lite": "^1.0.30001111", - "electron-to-chromium": "^1.3.523", - "escalade": "^3.0.2", - "node-releases": "^1.1.60" + "caniuse-lite": "^1.0.30001541", + "electron-to-chromium": "^1.4.535", + "node-releases": "^2.0.13", + "update-browserslist-db": "^1.0.13" } }, "caller-callsite": { @@ -1433,9 +1446,9 @@ "dev": true }, "caniuse-lite": { - "version": "1.0.30001115", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001115.tgz", - "integrity": "sha512-NZrG0439ePYna44lJX8evHX2L7Z3/z3qjVLnHgbBb/duNEnGo348u+BQS5o4HTWcrb++100dHFrU36IesIrC1Q==", + "version": "1.0.30001561", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001561.tgz", + "integrity": "sha512-NTt0DNoKe958Q0BE0j0c1V9jbUzhBxHIEJy7asmGrpE0yG63KTV7PLHPnK2E1O9RsQrQ081I3NLuXGS6zht3cw==", "dev": true }, "chalk": { @@ -1531,9 +1544,9 @@ } }, "electron-to-chromium": { - "version": "1.3.534", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.534.tgz", - "integrity": "sha512-7x2S3yUrspNHQOoPk+Eo+iHViSiJiEGPI6BpmLy1eT2KRNGCkBt/NUYqjfXLd1DpDCQp7n3+LfA1RkbG+LqTZQ==", + "version": "1.4.579", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.579.tgz", + "integrity": "sha512-bJKvA+awBIzYR0xRced7PrQuRIwGQPpo6ZLP62GAShahU9fWpsNN2IP6BSP1BLDDSbxvBVRGAMWlvVVq3npmLA==", "dev": true }, "emoji-regex": { @@ -1552,9 +1565,9 @@ } }, "escalade": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.0.2.tgz", - "integrity": "sha512-gPYAU37hYCUhW5euPeR+Y74F7BL+IBsV93j5cvGriSaD1aG6MGsqsV1yamRdrWrb2j3aiZvb0X+UBOWpx3JWtQ==", + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.1.tgz", + "integrity": "sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==", "dev": true }, "escape-string-regexp": { @@ -1643,9 +1656,9 @@ "dev": true }, "glob-parent": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.1.tgz", - "integrity": "sha512-FnI+VGOpnlGHWZxthPGR+QhR78fuiK0sNLkHQv+bL9fQi57lNNdquIbna/WrfROrolq8GK5Ek6BiMwqL/voRYQ==", + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", "dev": true, "requires": { "is-glob": "^4.0.1" @@ -1795,9 +1808,9 @@ } }, "lodash": { - "version": "4.17.20", - "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.20.tgz", - "integrity": "sha512-PlhdFcillOINfeV7Ni6oF1TAEayyZBoZ8bcshTHqOYJYlrqzRK5hagpagky5o4HfCzzd1TRkXPMFq6cKk9rGmA==", + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", "dev": true }, "log-symbols": { @@ -1826,9 +1839,9 @@ } }, "node-releases": { - "version": "1.1.60", - "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-1.1.60.tgz", - "integrity": "sha512-gsO4vjEdQaTusZAEebUWp2a5d7dF5DYoIpDG7WySnk7BuZDW+GPpHXoXXuYawRBr/9t5q54tirPz79kFIWg4dA==", + "version": "2.0.13", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.13.tgz", + "integrity": "sha512-uYr7J37ae/ORWdZeQ1xxMJe3NtdmqMC/JZK+geofDrkLUApKRHPd18/TxtBOJ4A0/+uUIliorNrfYV6s1b02eQ==", "dev": true }, "normalize-path": { @@ -1895,6 +1908,12 @@ "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", "dev": true }, + "picocolors": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-0.2.1.tgz", + "integrity": "sha512-cMlDqaLEqfSaW8Z7N5Jw+lyIW869EzT73/F5lhtY9cLGoVxSXznfgfXMO0Z5K0o0Q2TkTXq+0KFsdnSe3jDViA==", + "dev": true + }, "picomatch": { "version": "2.2.2", "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.2.2.tgz", @@ -1908,25 +1927,13 @@ "dev": true }, "postcss": { - "version": "7.0.32", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-7.0.32.tgz", - "integrity": "sha512-03eXong5NLnNCD05xscnGKGDZ98CyzoqPSMjOe6SuoQY7Z2hIj0Ld1g/O/UQRuOle2aRtiIRDg9tDcTGAkLfKw==", + "version": "7.0.39", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-7.0.39.tgz", + "integrity": "sha512-yioayjNbHn6z1/Bywyb2Y4s3yvDAeXGOyxqD+LnVOinq6Mdmd++SW2wUNVzavyyHxd6+DxzWGIuosg6P1Rj8uA==", "dev": true, "requires": { - "chalk": "^2.4.2", - "source-map": "^0.6.1", - "supports-color": "^6.1.0" - }, - "dependencies": { - "supports-color": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-6.1.0.tgz", - "integrity": "sha512-qe1jfm1Mg7Nq/NSh6XE24gPXROEVsWHxC1LIx//XNlD9iw7YZQGjZNjYN7xGaEG6iKdA8EtNFW6R0gjnVXp+wQ==", - "dev": true, - "requires": { - "has-flag": "^3.0.0" - } - } + "picocolors": "^0.2.1", + "source-map": "^0.6.1" } }, "postcss-cli": { @@ -2151,6 +2158,24 @@ "integrity": "sha512-rb6X1W158d7pRQBg5gkR8uPaSfiids68LTJQYOtEUhoJUWBdaQHsuT/EUduxXYxcrt4r5PJ4fuHW1MHT6p0qug==", "dev": true }, + "update-browserslist-db": { + "version": "1.0.13", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.0.13.tgz", + "integrity": "sha512-xebP81SNcPuNpPP3uzeW1NYXxI3rxyJzF3pD6sH4jE7o/IX+WtSpwnVU+qIsDPyk0d3hmFQ7mjqc6AtV604hbg==", + "dev": true, + "requires": { + "escalade": "^3.1.1", + "picocolors": "^1.0.0" + }, + "dependencies": { + "picocolors": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz", + "integrity": "sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==", + "dev": true + } + } + }, "which-module": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/which-module/-/which-module-2.0.0.tgz", From 569732bad661d19ab70232c274d46ccfbbd55a35 Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Thu, 9 Nov 2023 15:03:29 +0000 Subject: [PATCH 06/21] modified certificate requirements --- .../prerequisites.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md index e3c20ddfa..0b1745f53 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md @@ -66,20 +66,32 @@ In line with best practices, this account should not be given administrator righ ## Certificate Requirements -{{% ctx %}} Gateway requires an X.509 SSL certificate to be installed on the Web Application Server. The certificate must have the following properties: +The Flow Debugger and {{% ctx %}} Gateway require an X.509 SSL certificate to be installed on the Web Application Server. +
+For {{% ctx %}} Gateway, the certificate must have the following properties: * Enhanced Key Usage: `Server Authentication` and `Client Authentication` * Subject Alternative Names (SAN): At minimum the FQDN of the server. It can also include NetBIOS Name, IP address, localhost, 127.0.0.1 If the user tries to navigate to an address not in the SAN list, then they will receive a certificate error. +
+For the Flow Debugger, the certificate must have the following properties: + +* Subject field must be in a wildcard format, pertaining to the domain of the Application Servers (e.g. `CN=*.domain.com`). +* Subject alternative names must include any additional host names that should be able to be used to access the API Gateway Service. +* Certificate file must be in a .PFX file format, with a known password. +* Certificate file must contain the full chain of certificates. +* Certificate file must include the private key. +* Key Usage extension must have a value of `Digital Signature, Key Encipherment (a0)`. +* Enhanced Key Usage must include `Server Authentication` and `Client Authentication`. {{% alert title="Important" color="warning" %}} -Do not reuse any auto-generated self-signed certificates as they do not meet the requirements for Gateway. +Do not reuse any auto-generated self-signed certificates for {{% ctx %}} Gateway as they do not meet the requirements.
Certificates, wildcard certificates and manually created self-signed certificates can be used. However, the latter are not recommended for production instances. Details on how to create a self-signed certificate can be found at {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.CreateSelfSignedCertificates" title="Create Self-Signed Certificates" >}}.
-It is possible to reuse the certificate used when {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.DebuggerInstallation" title="installing the Debugger" >}}, as long as it is not an auto-generated self-signed certificate; If doing so, you should {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyNameNew" title="Assign a Certificate Friendly Name" >}} and set the `ImportCertificate` parameter to `$false` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" title="Configure CORTEX Gateway Installation Script" >}} to ensure use of the correct certificate and to prevent it from being overwritten. +It is possible to reuse the Flow Debugger certificate for {{% ctx %}} Gateway, as long as it is not an auto-generated self-signed certificate; If doing so, you must {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyNameNew" title="Assign a Certificate Friendly Name" >}} after the debugger has been installed and set the `ImportCertificate` parameter to `$false` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" title="Configure CORTEX Gateway Installation Script" >}} to ensure use of the correct certificate and to prevent it from being overwritten. {{% /alert %}} ### Import Root Certificate From 1f558b216d00295e13f69800c9d656992ec46a80 Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Fri, 10 Nov 2023 14:56:17 +0000 Subject: [PATCH 07/21] started to improve web app server install instructions for 7.2 --- .../single-server/check-port-useage.md | 30 ++--- .../configure-debugger-installation-script.md | 74 +++++++++++ .../install-web-application-server/_index.md | 10 ++ .../perform-debugger-installation.md | 60 +++++++++ .../perform-gateway-installation.md | 119 ++++++++++++++++++ .../prerequisites.md | 53 ++++++++ ... => old install-web-application-server.md} | 4 +- data/urls.toml | 6 + 8 files changed, 339 insertions(+), 17 deletions(-) create mode 100644 content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md create mode 100644 content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/_index.md create mode 100644 content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md create mode 100644 content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md create mode 100644 content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/prerequisites.md rename content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/{install-web-application-server.md => old install-web-application-server.md} (99%) diff --git a/content/en/docs/2023.11/_shared/install-application-server/single-server/check-port-useage.md b/content/en/docs/2023.11/_shared/install-application-server/single-server/check-port-useage.md index b3f7447f8..0b1f03420 100644 --- a/content/en/docs/2023.11/_shared/install-application-server/single-server/check-port-useage.md +++ b/content/en/docs/2023.11/_shared/install-application-server/single-server/check-port-useage.md @@ -1,23 +1,23 @@ -1. To check all necessary ports are free, follow these steps. - 1. Open a Windows PowerShell (x64) window as administrator. - 1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: +To check all necessary ports are free, follow these steps. +1. Open a Windows PowerShell (x64) window as administrator. +1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: - ```powershell - cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" - ``` + ```powershell + cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" + ``` - 1. Run the `Cortex.Innovation.Test.PortUsage.ps1` script using the following command, modifying the `ApplicationServers` value to contain the NETBIOS name or fully qualified domain name of the server: +1. Run the `Cortex.Innovation.Test.PortUsage.ps1` script using the following command, modifying the `ApplicationServers` value to contain the NETBIOS name or fully qualified domain name of the server: - ```powershell - .\Cortex.Innovation.Test.PortUsage.ps1 -ApplicationServers @("app-server1") - ``` + ```powershell + .\Cortex.Innovation.Test.PortUsage.ps1 -ApplicationServers @("app-server1") + ``` - 1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK. +1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK. - 1. If all ports are free, the script will report the following: +1. If all ports are free, the script will report the following: - `All ports required by Cortex Innovation are free` + `All ports required by Cortex Innovation are free` - If this is the case, continue to the next section. Otherwise, consult the messages returned by the script, which will give details about how to modify the `Cortex.Innovation.Install.Config.json` configuration file, in the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder, to use different ports. This will be used later during installation. + If this is the case, continue to the next section. Otherwise, consult the messages returned by the script, which will give details about how to modify the `Cortex.Innovation.Install.Config.json` configuration file, in the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder, to use different ports. This will be used later during installation. - The `Cortex.Innovation.Test.PortUsage.ps1` script cannot currently re-check modified ports in the configuration file so these need to be manually checked to see that they are free. + The `Cortex.Innovation.Test.PortUsage.ps1` script cannot currently re-check modified ports in the configuration file so these need to be manually checked to see that they are free. diff --git a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md new file mode 100644 index 000000000..9c6c38753 --- /dev/null +++ b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md @@ -0,0 +1,74 @@ +1. In the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder, locate the `Cortex.Innovation.Install.ps1` script and open it with a text editor. +1. Choose the tab below that matches the configuration for this installation, then update the script to match, changing the parameters according to the details given below: + + {{< tabpane lang="powershell" >}} + {{< tab header="CA Certs" >}} +.\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` + -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` + -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` + -ApiGatewayBasicAuthUsername "BasicAuthUser" ` + -ApiGatewayBasicAuthPassword "ADA9883B11BD4CDC908B8131B57944A4" ` + -CustomerName "Customer1" ` + -ApplicationServerIPv4Addresses @("192.168.1.1") ` + -ServerCertificatePath "C:\Install\Certificates\cert.pfx" ` + -ServerCertificatePassword "myPassword" ` + -SkipLoadBalancer ` + -Credential $Credential ` + -LdapConnectionDetails @{ + Host= "LDAP://ldapserver.fqdn.com:389" + UseSsl= $false + Username= "someUserName" + Password= "somePassword" + } ` + -AcceptEULA:$AcceptEula ` + *>&1 | Tee-Object -FilePath "cortex-app-install-log.txt" + {{< /tab >}} + {{< tab header="Self-Signed Certs" >}} +.\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` + -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` + -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` + -ApiGatewayBasicAuthUsername "BasicAuthUser" ` + -ApiGatewayBasicAuthPassword "ADA9883B11BD4CDC908B8131B57944A4" ` + -CustomerName "Customer1" ` + -ApplicationServerIPv4Addresses @("192.168.1.1") ` + -UseSelfSignedCertificates ` + -SkipLoadBalancer ` + -Credential $Credential ` + -LdapConnectionDetails @{ + Host= "LDAP://ldapserver.fqdn.com:389" + UseSsl= $false + Username= "someUserName" + Password= "somePassword" + } ` + -AcceptEULA:$AcceptEula ` + *>&1 | Tee-Object -FilePath "cortex-app-install-log.txt" + {{< /tab >}} + {{< /tabpane >}} + + | Name | Description | + |----------------------------------------------|-------------| + |`AppServicesPath` | Configure this value with the location of the App Services zip file on the server. | + |`BlockPackagesPath` | Configure this value with the location of the Block Packages zip file on the server. | + |`ApiGatewayBasicAuthUsername` | Configure this value with a username that can be used to make HTTPS requests to the API Gateway Service using Basic Authentication (e.g. starting flows). This username will be used by Gateway for all HTTPS requests to the API Gateway Service.

For security reasons it is recommended that the default value `BasicAuthUser` should be changed.

This value will be needed later, [when upgrading Gateway][Install Gateway].

This username can also be used by external services for HTTPS requests to the API Gateway Service but is not recommended; these requests should use an OAuth2 session for an authorised Active Directory user.| + |`ApiGatewayBasicAuthPassword` | Configure this value with the password for the username specified for `ApiGatewayBasicAuthUsername`.

This password should be [{{% ctx %}} Encrypted][CORTEX Encrypted]. For security reasons it is recommended that the default value `ADA9883B11BD4CDC908B8131B57944A4` should be changed.

This value will be needed later, [when upgrading Gateway][Install Gateway].| + |`CustomerName` | A name identifying the platform being installed. This must have no spaces or symbols. It will be appended to the node names that are displayed in Service Fabric Explorer. | + |`ApplicationServerIPv4Addresses` | The IPv4 address of the server.| + |`ServerCertificatePath` | The local path of a .PFX certificate file on the server. Environment variables cannot be used.

This is only needed if installing with CA Certificates (Recommended). The certificate should meet the [Certificate Requirements][].

This certificate will be used for:
  • Securing communication between the Application Services.
  • Allowing Application Services to identify themselves to clients such as Gateway.
  • Preventing unauthorised nodes from joining the single node cluster.
  • Connecting to Service Fabric Explorer from each of the Application Servers.
{{< alert type="warning" title="Warning" >}}It is critical to set a reminder to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.RolloverCertificates" title="update certificates" >}} in good time before they expire. If they expire then the platform will cease to function and {{< ahref path="Cortex.ServicePortal.MainDoc" title="CORTEX Service Portal" >}} must be contacted for support.{{< /alert >}}| + |`ServerCertificatePassword` | The password for the .PFX certificate file specified in `ServerCertificatePath`.

This is only needed if installing with CA Certificates (Recommended).| + |`UseSelfSignedCertificates` | Installs Application Services and required infrastructure using generated Self-Signed Certificates rather than CA Certificates.

Not recommended for production use. | + |`SkipLoadBalancer` | Installs Application Services and required infrastructure without installing a load balancer. | + |`Credential` | The credentials of the user which will be used to perform remote operations on the server. It must be a domain user that is a member of the local Administrators group on the server.

This does not need to be changed, a prompt will appear to enter this information when the script is run. | + |`LdapConnectionDetails` | The connection details to the LDAP server.

This must be configured with a valid `Host`, `Username`, `Password`, and whether the LDAP server uses SSL using `UseSsl`. {{< alert type="note" title="Note" >}}All fields but `UseSsl` can be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | + |`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. | + |`FilePath` | The filename that installation logs are written to. If this should be written to a different location than where the installation files are then a full path should be specified. | + + The `ApiGatewayBasicAuthUsername` and `ApiGatewayBasicAuthPassword` will be needed later, [when upgrading Gateway][Install Gateway]. + + {{% alert title="Note" %}} +More advanced configuration (such as changing ports) can be undertaken by modifying the `Cortex.Innovation.Install.Config.json` file but this shouldn't be required for most installations. More information about this can be found at {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.AdvancedConfigSingleServer" title="Advanced Application Server and Load Balancer Configuration Changes" >}}. + {{% /alert %}} + +1. Save and close `Cortex.Innovation.Install.ps1`. + +[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.CertificateRequirements" >}} +[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/_index.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/_index.md new file mode 100644 index 000000000..61fc85dee --- /dev/null +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/_index.md @@ -0,0 +1,10 @@ +--- +title: "Install the Web Application Server" +linkTitle: "Install Web Application Server" +description: "Information about installing the Web Application Server." +weight: 40 +--- + +This guide describes how to upgrade {{% ctx %}} Gateway on v7.2 to include Innovation. Please ensure that [Install Application Servers and Load Balancer][] has been completed before starting this installation. These steps assume that the v7.2 version of Gateway and its prerequisites have already been installed. + +[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md new file mode 100644 index 000000000..d008cb7f9 --- /dev/null +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md @@ -0,0 +1,60 @@ +--- +title: "Perform Flow Debugger Installation" +linkTitle: "Perform Flow Debugger Installation" +description: "Information about installing the Flow Debugger." +weight: 20 +--- + +# {{% param title %}} + +This guide describes how to install the Flow Debugger on the Web Application Server. Please ensure that the [web application server prerequisites][] have been completed before starting this installation. + +{{% alert title="Important" color="warning" %}} +{{< ctx >}} Gateway requires a local instance of the Application Server components to enable the debugging of flows. +{{% /alert %}} + +## Install Microsoft .NET Framework 4.7.2 + +{{< section "/install-application-server/install-dot-net-framework.md">}} + +## Add Antivirus Exclusions + +If Windows Defender is not running on the server, ensure that the [Antivirus Exclusions][] have been added to the running antivirus software on the server and continue to the next section, otherwise follow these steps: + +{{< section "/install-application-server/single-server/add-antivirus-exclusions.md">}} + +## Check Port Usage + +{{< section "/install-application-server/single-server/check-port-useage.md">}} + +## Configure Installation Script + +{{< section "/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md">}} + +## Test Installation Script + +{{< section "/install-application-server/single-server/test-installation-script.md">}} + +## Run Installation Script + +{{< section "/install-application-server/single-server/run-installation-script.md">}} + +## Add Read and Execute access to Windows Crypto folder + +{{< section "/install-application-server/single-server/add-permissions-to-crypto-folder.md">}} + +## Check Application Services + +{{< section "/install-application-server/single-server/check-application-services.md">}} + +# Preserve installation files + +{{< section "/preserve-installation-files.md">}} + +## Next Steps? + +1. [Perform Gateway Installation][] + +[Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AntivirusExclusions" >}} +[Perform Gateway Installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.GatewayInstallation" >}} +[web application server prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.WebApplicationServerPrerequisites" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md new file mode 100644 index 000000000..d10bc4e54 --- /dev/null +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md @@ -0,0 +1,119 @@ +--- +title: "Perform Gateway Installation" +linkTitle: "Perform Gateway Installation" +description: "Information about upgrading v7.2 {{% ctx %}} Gateway to include Innovation." +weight: 30 +--- + +# {{% param title %}} + +This guide describes how to upgrade {{% ctx %}} Gateway on v7.2 to include Innovation. Please ensure that the [Flow Debugger installation][] has been completed before starting this installation. + +## Perform Gateway Installation + +### Configure {{% ctx %}} Gateway Installation Script + +1. In the `Cortex Innovation {{< version >}} - Web App Server Install Scripts` folder, locate the `Cortex.Innovation.Install.Gateway.ps1` script and open it with a text editor. +1. Configure the script according to the details given below: + + ```powershell + .\Cortex.Install.Gateway.ps1 ` + -GatewayPackagePath "C:\Install\Cortex Innovation {{< version >}} - Gateway.zip" ` + -FeatureFlags "InnovationId" ` + -ServiceFabricApiGatewayEndpoint "https://server.domain.com/" ` + -ServiceFabricUsingSelfSignedCertificates $false ` + -ServiceFabricApiGatewayBasicAuthUsername "BasicAuthUser" ` + -ServiceFabricApiGatewayBasicAuthPassword 'ADA9883B11BD4CDC908B8131B57944A4' ` + -DotNetFlowDebuggerEndpoint "https://server.domain.com:8722/api/" ` + -DotNetFlowDebuggerBasicAuthUsername "BasicAuthUser" ` + -DotNetFlowDebuggerBasicAuthPassword 'ADA9883B11BD4CDC908B8131B57944A4' ` + -DotNetFlowDebuggerUsingSelfSignedCertificates $false ` + -GatewayApplicationPoolUsername "Domain\Username" ` + -WebRootFolder "C:\inetpub\wwwroot" ` + -WebsitePort "443" ` + -ImportCertificate $false ` + -CertificateFilePath "C:\Install\Certificate.pfx" ` + -CertificateFriendlyName "CertificateName" ` + -ConfigureSiteRedirect $true ` + -ApplySecurityMeasures $true ` + -UsingWindowsDefender $false ` + -AcceptEULA:$AcceptEula ` + *>&1 | Tee-Object -FilePath "cortex-gateway-install-log.txt" + ``` + + | Name | Description | + |------------------------------------------------|-------------| + |`GatewayPackagePath` | Configure this value with the location of the `Cortex Innovation {{< version >}} - Gateway.zip` file on the installation server. | + |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} Innovation feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Licensing Requirements][], if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the Gateway web.config.| + |`ServiceFabricApiGatewayEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the Load Balancer Server. The port should be specified if it is not the default HTTPS port (443), and there must be a trailing slash, e.g. `https://server.domain.com/` or `https://server.domain.com:8722/`.

This will set the `ServiceFabricApiGatewayEndpoint` value in the {{% ctx %}} Gateway web.config.| + |`ServiceFabricUsingSelfSignedCertificates` | Configure the value as `$false` if you used valid CA certificates when [installing the Application Servers][Configure Installation Script], `$true` if you used self-signed certificates.

This will set the `ServiceFabricUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| + |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used.

This will set the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.| + |`ServiceFabricApiGatewayBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used. It can be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This will set the `ServiceFabricApiGatewayBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.| + |`DotNetFlowDebuggerEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the Web Application Server.

This will set the `DotNetFlowDebuggerEndpoint` value in the {{% ctx %}} Gateway web.config.| + |`DotNetFlowDebuggerBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Debugger on the Web Application Server][Flow Debugger Installation]; if so, this value must be configured to the one used.

This will overwrite the `DotNetFlowDebuggerBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.| + |`DotNetFlowDebuggerBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Debugger on the Web Application Server][Flow Debugger Installation]; if so, this value must be configured to the one used. It can be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This will overwrite the `DotNetFlowDebuggerBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.| + |`DotNetFlowDebuggerUsingSelfSignedCertificates` | Configure the value as `$false` if you are using valid CA certificates to secure the communication between {{% ctx %}} Gateway and the Debugger, `$true` if using self-signed certificates.

This will set the `DotNetFlowDebuggerUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| + |`GatewayApplicationPoolUsername` | Replace `Domain\Username` with the user that is used to run the {{% ctx %}} Gateway application pool currently.| + |`WebRootFolder` | Replace this with the correct path for the Web Root Folder on the server. Typically this will be `C:\inetpub\wwwroot`.| + |`WebsitePort` | Replace this with the port that you wish the website to use. Typically this will be `443`.| + |`ImportCertificate` | This should be set to `$false` if the certificate is already imported.

Note that prior to installation the certificate must be [assigned a friendly name][Assign Certificate Friendly Name]. + |`CertificateFilePath` | Replace this with the location and filename for the certificate to be imported.

If `ImportCertificate` is set to `$false` this value can remain unchanged.| + |`CertificateFriendlyName` | Replace this with the friendly name that you would like to be allocated to the certificate.

If `ImportCertificate` is set to `$false` this must be [assigned][Assign Certificate Friendly Name] prior to running the installation and the Friendly Name used must be specified to allow the website to use the correct certificate.| + |`ConfigureSiteRedirect` | If the site hosting the {{% ctx %}} Gateway web application is a newly created Cortex site or an existing site that doesn’t have its own content, it is recommended to redirect the site URL to the {{% ctx %}} Gateway web application URL. The default behaviour of the script is to create a URL Rewrite redirect rule to achieve this.

To skip this rule creation change the value to `$false`.| + |`ApplySecurityMeasures` | Change this from `$true` to `$false` if you do not require the Recommended [Security Best Practices][] to be implemented as part of the installation process.| + |`UsingWindowsDefender` | Change this from `$true` to `$false` if you are not using the Windows Defender firewall.

If Windows Defender is not being used but an alterntive firewall is, it must be configured to allow communication inbound via TCP on the port configured for HTTPS (usually 443).| + |`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. | + |`FilePath` | The filename that installation logs are written to. If this should be written to a different location than where the installation files are then a full path should be specified. | + +1. Save and close `Cortex.Innovation.Install.Gateway.ps1`. + +### Install {{% ctx %}} Gateway + +1. Open a Windows PowerShell (x64) window as administrator. +1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - Web App Server Install Scripts` folder using the following command, modifying the path as necessary: + + ```powershell + cd "C:\Install\Cortex Innovation {{< version >}} - Web App Server Install Scripts" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.Install.Gateway.ps1 + ``` + +1. Please read the End User Licence Agreement which can be found [here][Eula]. Once you agree to the terms, add the flag `-AcceptEULA` to the command entered above, e.g: + + ```powershell + .\.ps1 -AcceptEULA + ``` + +1. Run the PowerShell command to install {{% ctx %}} Gateway. +1. If `ImportCertificate` is set to $true, and the file is of type `.pfx`, a prompt will appear for the certificate password. This should be entered, and then hit `Enter`. +1. A prompt will appear to enter the password for the user specified to run the {{% ctx %}} Gateway Application Pool. This should be entered, and then hit `Enter`. +1. Check that there have been no errors in the script; these would appear in red in the console. + + If there are any errors, then please follow any instructions given within them to rectify the situation, and retry the installation. + + If the errors do not give any instructions on how to rectify, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for further assistance. + +1. Once the PowerShell script execution has completed, a prompt will appear to restart the machine. You can choose to restart now (`N`) or later (`L`). +1. In a browser, navigate to the {{% ctx %}} Gateway website, available at `://:/`, e.g. `https://localhost/gateway` and wait for the login page to load. + +### Grant additional folder permissions to the {{% ctx %}} Gateway Application Pool User + +{{< section "/install-web-application-server/grant-gateway-user-additional-folder-permissions.md">}} + +## Next Steps? + +1. [Setup {{% ctx %}} Gateway][Setup CORTEX Gateway] + +[Assign Certificate Friendly Name]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AssignCertificateFriendlyNameNew" >}} +[Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} +[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureInstallationScript" >}} +[CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} +[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} +[Flow Debugger installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.DebuggerInstallation" >}} +[Get CORTEX Gateway Application Pool User]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.GetGatewayAppPoolUser" >}} +[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.LicensingRequirements" >}} +[Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/prerequisites.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/prerequisites.md new file mode 100644 index 000000000..88273a26b --- /dev/null +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/prerequisites.md @@ -0,0 +1,53 @@ +--- +title: "Prerequisites" +linkTitle: "Prerequisites" +description: "Information about performing the prerequisities for the Web Application Server." +weight: 10 +--- + +# {{% param title %}} + +Please ensure that [Install Application Servers and Load Balancer][] has been completed before starting this installation. These steps assume that the v7.2 version of Gateway and its prerequisites have already been installed. + +## Make Installation Artefacts Available + +{{% alert title="Note" %}} +We recommend that the single-node Service Fabric instance, used by {{% ctx %}} Gateway as a Debugger instance, and {{% ctx %}} Gateway are installed on the same Web Application Server. +{{% /alert %}} + +{{< section "/install-web-application-server/make-installation-artefacts-available.md">}} + +## Licensing + +{{< section "/install-web-application-server/add-innovation-to-7.2/licensing.md">}} + +## Grant folder permissions to the {{% ctx %}} Gateway Application Pool User + +{{< section "/install-web-application-server/grant-gateway-user-folder-permissions.md">}} + +## Certificate Requirements + +In order to ensure that the correct certificate is used during the upgrade of {{% ctx %}} Gateway, it is necessary to [assign a friendly name][Assign Certificate Friendly Name] to the certificate that is currently being used for {{% ctx %}} Gateway. It is important to set the `ImportCertificate` parameter to `$false` when [configuring the {{% ctx %}} Gateway installation script][Configure CORTEX Gateway Installation Script]. +
+The Flow Debugger also requires an X.509 SSL certificate to be installed on the Web Application Server. This can use the same certificate as {{% ctx %}} Gateway, however it must have the following properties: + +* Subject field must be in a wildcard format, pertaining to the domain of the Application Servers (e.g. `CN=*.domain.com`). +* Subject alternative names must include any additional host names that should be able to be used to access the API Gateway Service. +* Certificate file must be in a .PFX file format, with a known password. +* Certificate file must contain the full chain of certificates. +* Certificate file must include the private key. +* Key Usage extension must have a value of `Digital Signature, Key Encipherment (a0)`. +* Enhanced Key Usage must include `Server Authentication` and `Client Authentication`. + +### Assign Certificate Friendly Name + +{{< section "/install-web-application-server/add-innovation-to-7.2/assign-certificate-friendly-name.md">}} + +## Next Steps? + +1. [Perform Flow Debugger Installation][] + +[Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} +[Configure CORTEX Gateway Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} +[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} +[Perform Flow Debugger Installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.DebuggerInstallation" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/old install-web-application-server.md similarity index 99% rename from content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server.md rename to content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/old install-web-application-server.md index bc9595006..26a81fe55 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/old install-web-application-server.md @@ -1,6 +1,6 @@ --- -title: "Upgrade v7.2 Gateway to Include Innovation" -linkTitle: "Upgrade v7.2 Gateway to Include Innovation" +title: "Upgrade v7.2 Gateway to Include Innovation Old" +linkTitle: "Upgrade v7.2 Gateway to Include Innovation Old" description: "Information about upgrading v7.2 Gateway with Innovation functionality." weight: 40 --- diff --git a/data/urls.toml b/data/urls.toml index ad3868ffe..6d0ab2747 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -166,7 +166,11 @@ InstallApplicationAndLoadBalancerServers = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers" InstallWebApplicationServer = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server" ConfigureCortexGatewayInstallationScript = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/#configure-cortex-gateway-installation-script" + ConfigureCortexGatewayInstallationScriptNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation/#configure-cortex-gateway-installation-script" ConfigureInstallationScript = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers#configure-installation-script" + DebuggerInstallation = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-debugger-installation" + GatewayInstallation = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation" + GetGatewayAppPoolUser = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/prerequisites/#get-cortex-gateway-application-pool-user" RunInstallationScript = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers#run-installation-script" AddInnovationTo72WebApplicationServer = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server" UpgradeGateway = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/#upgrade-gateway" @@ -179,6 +183,8 @@ AntivirusExclusions = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites#antivirus-exclusions" HardwareRequirements = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites#hardware-requirements" HardwareRequirementsAlternativeArchitecture = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites#alternative-architectures" + AssignCertificateFriendlyNameNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/prerequisites/#assign-certificate-friendly-name" + WebApplicationServerPrerequisites = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/prerequisites" [Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA] MainDoc = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/" Architecture = "/docs/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/architecture" From 1833d03c6b18087510819125eebc6437d9b46574 Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Fri, 10 Nov 2023 19:54:03 +0000 Subject: [PATCH 08/21] finalised web app sever changes --- .../perform-gateway-installation.md | 11 +- .../old install-web-application-server.md | 213 ------------------ .../perform-gateway-installation.md | 4 + 3 files changed, 11 insertions(+), 217 deletions(-) delete mode 100644 content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/old install-web-application-server.md diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md index d10bc4e54..860a04177 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md @@ -67,7 +67,7 @@ This guide describes how to upgrade {{% ctx %}} Gateway on v7.2 to include Innov 1. Save and close `Cortex.Innovation.Install.Gateway.ps1`. -### Install {{% ctx %}} Gateway +### Upgrade {{% ctx %}} Gateway 1. Open a Windows PowerShell (x64) window as administrator. 1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - Web App Server Install Scripts` folder using the following command, modifying the path as necessary: @@ -90,7 +90,6 @@ This guide describes how to upgrade {{% ctx %}} Gateway on v7.2 to include Innov 1. Run the PowerShell command to install {{% ctx %}} Gateway. 1. If `ImportCertificate` is set to $true, and the file is of type `.pfx`, a prompt will appear for the certificate password. This should be entered, and then hit `Enter`. -1. A prompt will appear to enter the password for the user specified to run the {{% ctx %}} Gateway Application Pool. This should be entered, and then hit `Enter`. 1. Check that there have been no errors in the script; these would appear in red in the console. If there are any errors, then please follow any instructions given within them to rectify the situation, and retry the installation. @@ -104,9 +103,13 @@ This guide describes how to upgrade {{% ctx %}} Gateway on v7.2 to include Innov {{< section "/install-web-application-server/grant-gateway-user-additional-folder-permissions.md">}} +# Preserve installation files + +{{< section "/preserve-installation-files.md">}} + ## Next Steps? -1. [Setup {{% ctx %}} Gateway][Setup CORTEX Gateway] +1. [Try it out][] [Assign Certificate Friendly Name]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AssignCertificateFriendlyNameNew" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} @@ -114,6 +117,6 @@ This guide describes how to upgrade {{% ctx %}} Gateway on v7.2 to include Innov [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} [Flow Debugger installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.DebuggerInstallation" >}} -[Get CORTEX Gateway Application Pool User]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.GetGatewayAppPoolUser" >}} [Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.LicensingRequirements" >}} [Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} +[Try it out]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.TryItOut" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/old install-web-application-server.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/old install-web-application-server.md deleted file mode 100644 index 26a81fe55..000000000 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/old install-web-application-server.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -title: "Upgrade v7.2 Gateway to Include Innovation Old" -linkTitle: "Upgrade v7.2 Gateway to Include Innovation Old" -description: "Information about upgrading v7.2 Gateway with Innovation functionality." -weight: 40 ---- - -# {{< param title >}} - -This guide describes how to upgrade Gateway on v7.2 to include Innovation. Please ensure that [Install Application Servers and Load Balancer][] has been completed before starting this installation. These steps assume that the v7.2 version of Gateway and its prerequisites have already been installed. - -The steps to add Innovation functionality to 7.2 are: - -1. Install local instance of the Application Server components -1. Upgrade {{% ctx %}} Gateway - -## Make Installation Artefacts Available - -{{% alert title="Note" %}} -We recommend that the single-node Service Fabric instance, used by {{% ctx %}} Gateway as a Debugger instance, and {{% ctx %}} Gateway are installed on the same Web Application Server. -{{% /alert %}} - -{{< section "/install-web-application-server/make-installation-artefacts-available.md">}} - -## Install Prerequisites - -### Licensing - -{{< section "/install-web-application-server/add-innovation-to-7.2/licensing.md" >}} - -### Grant folder permissions to the {{% ctx %}} Gateway Application Pool User - -{{< section "/install-web-application-server/grant-gateway-user-folder-permissions.md">}} - -### Certificate Requirements - -In order to ensure that the correct certificate is used during the upgrade of {{% ctx %}} Gateway, it is necessary to [assign a friendly name][Assign Certificate Friendly Name] to the certificate that is currently being used for {{% ctx %}} Gateway. It is important to set the `ImportCertificate` parameter to `$false` when [configuring the {{% ctx %}} Gateway installation script][Configure CORTEX Gateway Installation Script]. - -#### Assign Certificate Friendly Name - -{{< section "/install-web-application-server/add-innovation-to-7.2/assign-certificate-friendly-name.md">}} - -## Perform Debugger Installation - -{{% alert title="Important" color="warning" %}} -{{< ctx >}} Gateway requires a local instance of the Application Server components to enable the debugging of flows. -{{% /alert %}} - -### Install Debugger - -To install the components required for debugging, perform the steps detailed in [Install Application Server][] on the Web Application Server. - -## Perform Gateway Installation - -### Configure {{% ctx %}} Gateway Installation Script - -1. In the `Cortex Innovation {{< version >}} - Web App Server Install Scripts` folder, locate the `Cortex.Innovation.Install.Gateway.ps1` script and open it with a text editor. -1. Configure the script according to the details given below: - - ```powershell - .\Cortex.Install.Gateway.ps1 ` - -GatewayPackagePath "C:\Install\Cortex Innovation {{< version >}} - Gateway.zip" ` - -FeatureFlags "InnovationId" ` - -ServiceFabricApiGatewayEndpoint "https://server.domain.com/" ` - -ServiceFabricUsingSelfSignedCertificates $false ` - -ServiceFabricApiGatewayBasicAuthUsername "BasicAuthUser" ` - -ServiceFabricApiGatewayBasicAuthPassword "ADA9883B11BD4CDC908B8131B57944A4" ` - -DotNetFlowDebuggerEndpoint "https://server.domain.com:8722/api/" ` - -DotNetFlowDebuggerBasicAuthUsername "BasicAuthUser" ` - -DotNetFlowDebuggerBasicAuthPassword "ADA9883B11BD4CDC908B8131B57944A4" ` - -DotNetFlowDebuggerUsingSelfSignedCertificates $false ` - -GatewayApplicationPoolUsername "Domain\Username" ` - -WebRootFolder "C:\inetpub\wwwroot" ` - -WebsitePort "443" ` - -ImportCertificate $false ` - -CertificateFilePath "C:\Install\Certificate.pfx" ` - -CertificateFriendlyName "CertificateName" ` - -ConfigureSiteRedirect $true ` - -ApplySecurityMeasures $true ` - -UsingWindowsDefender $false ` - -AcceptEULA:$AcceptEula ` - *>&1 | Tee-Object -FilePath "cortex-gateway-install-log.txt" - ``` - - | Name | Description | - |------------------------------------------------|-------------| - |`GatewayPackagePath` | Configure this value with the location of the `Cortex Innovation {{< version >}} - Gateway.zip` file on the installation server. | - |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} Innovation feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Licensing Requirements][], if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will overwrite the `FeatureFlags` value in the Gateway web.config.| - |`ServiceFabricApiGatewayEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the Load Balancer Server. The port should be specified if it is not the default HTTPS port (443), and there must be a trailing slash, e.g. `https://server.domain.com/` or `https://server.domain.com:8722/`.

This will overwrite the `ServiceFabricApiGatewayEndpoint` value in the {{% ctx %}} Gateway web.config.| - |`ServiceFabricUsingSelfSignedCertificates` | Configure the value as `$false` if you used valid CA certificates when [installing the Application Servers][Configure Installation Script], `$true` if you used self-signed certificates.

This will overwrite the `ServiceFabricUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| - |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used.

This will overwrite the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.| - |`ServiceFabricApiGatewayBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used. It can be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This will overwrite the `ServiceFabricApiGatewayBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.| - |`DotNetFlowDebuggerEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the Web Application Server.

This will overwrite the `DotNetFlowDebuggerEndpoint` value in the {{% ctx %}} Gateway web.config.| - |`DotNetFlowDebuggerBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Debugger on the Web Application Server][Install Application Server]; if so, this value must be configured to the one used.

This will overwrite the `DotNetFlowDebuggerBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.| - |`DotNetFlowDebuggerBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Debugger on the Web Application Server][Install Application Server]; if so, this value must be configured to the one used. It can be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This will overwrite the `DotNetFlowDebuggerBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.| - |`DotNetFlowDebuggerUsingSelfSignedCertificates` | Configure the value as `$false` if you are using valid CA certificates to secure the communication between {{% ctx %}} Gateway and the Debugger, `$true` if using self-signed certificates.

This will overwrite the `DotNetFlowDebuggerUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| - |`GatewayApplicationPoolUsername` | Replace `Domain\Username` with the user that is used to run the {{% ctx %}} Gateway application pool currently.| - |`WebRootFolder` | Replace this with the correct path for the Web Root Folder on the server. Typically this will be `C:\inetpub\wwwroot`.| - |`WebsitePort` | Replace this with the port that you wish the website to use. Typically this will be `443`.| - |`ImportCertificate` | This should be set to `$false` if the certificate is already imported.

Note that prior to installation the certificate must be [assigned a friendly name][Assign Certificate Friendly Name]. - |`CertificateFilePath` | Replace this with the location and filename for the certificate to be imported.

If `ImportCertificate` is set to `$false` this value can remain unchanged.| - |`CertificateFriendlyName` | Replace this with the friendly name that you would like to be allocated to the certificate.

If `ImportCertificate` is set to `$false`, this must be [assigned][Assign Certificate Friendly Name] prior to running the installation and the Friendly Name used must be specified to allow the website to use the correct certificate.| - |`ConfigureSiteRedirect` | If the site hosting the {{% ctx %}} Gateway web application is a newly created {{% ctx %}} site or an existing site that doesn’t have its own content, it is recommended to redirect the site URL to the {{% ctx %}} Gateway web application URL. The default behaviour of the script is to create a URL Rewrite redirect rule to achieve this.

To skip this rule creation change the value to `$false`.| - |`ApplySecurityMeasures` | Change this from `$true` to `$false` if you do not require the Recommended [Security Best Practices][] to be implemented as part of the installation process.| - |`UsingWindowsDefender` | Change this from `$true` to `$false` if you are not using the Windows Defender firewall.

If Windows Defender is not being used but an alterntive firewall is, it must be configured to allow communication inbound via TCP on the port configured for HTTPS (usually 443).| - |`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. | - |`FilePath` | The filename that installation logs are written to. If this should be written to a different location than where the installation files are then a full path should be specified. | - -1. Save and close `Cortex.Innovation.Install.Gateway.ps1`. - -### Upgrade {{% ctx %}} Gateway - -1. Open a Windows PowerShell (x64) window as administrator. -1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - Web App Server Install Scripts` folder using the following command, modifying the path as necessary: - - ```powershell - cd "C:\Install\Cortex Innovation {{< version >}} - Web App Server Install Scripts" - ``` - -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.Install.Gateway.ps1 - ``` - -1. Please read the End User Licence Agreement which can be found [here][Eula]. Once you agree to the terms, add the flag `-AcceptEULA` to the command entered above, e.g: - - ```powershell - .\.ps1 -AcceptEULA - ``` - -1. Run the PowerShell command to upgrade {{% ctx %}} Gateway. -1. If `ImportCertificate` is set to $true, and the file is of type `.pfx`, a prompt will appear for the certificate password. This should be entered, and then hit `Enter`. -1. Check that there have been no errors in the script; these would appear in red in the console. - - If there are any errors, then please follow any instructions given within them to rectify the situation, and retry the installation. - - If the errors do not give any instructions on how to rectify, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for further assistance. - -1. Once the PowerShell script execution has completed, a prompt will appear to restart the machine. You can choose to restart now (`N`) or later (`L`). -1. In a browser, navigate to the {{% ctx %}} Gateway website, available at `://:/`, e.g. `https://localhost/gateway` and wait for the login page to load. - -### Grant additional folder permissions to the {{% ctx %}} Gateway Application Pool User - -#### Cortex Blocks Provider Host folder - -Check that the {{% ctx %}} Gateway `Application Pool` user has rights to the `Cortex Blocks Provider Host folder` folder using the following steps: - -1. Navigate to `C:\ProgramData\Cortex` -1. Right-click on the `Cortex Blocks Provider Host` folder and click `Properties`. -1. In the dialog, click the `Security` tab. -1. Check the `Application Pool` user for Gateway is listed in the `Group or user names` and has `Modify` permissions. -1. If the `Application Pool` user for Gateway is not listed: - 1. Click the `Edit...` button. - 1. Click the `Add...` button. - 1. Enter the username of the application pool user and click `OK`. - 1. In the `Permissions` section at the bottom, check `Modify`. - 1. Click `OK`. -1. If the `Application Pool` user for Gateway is listed but does not have permissions: - 1. Click the `Edit...` button. - 1. Select the `Application Pool` user. - 1. Check `Modify`. - 1. Click `OK`. - -#### Repo folder - -Check that the {{% ctx %}} Gateway `Application Pool` user has rights to the `Repo` folder using the following steps: - -1. Check where the `Repo` folder is located - 1. Navigate to the `gateway` IIS folder (usually `%SystemDrive%\inetpub\wwwroot\Cortex\gateway`, e.g. `C:\inetpub\wwwroot\Cortex\gateway`) - 1. Open the `web.config` file. - 1. Find the value of the `connectionString` named `CortexRepositories` -1. Navigate to the `Repo` folder, not opening it. -1. Right-click on the `Repo` folder and click `Properties`. -1. In the dialog, click the `Security` tab. -1. Check the `Application Pool` user for Gateway is listed in the `Group or user names` and has `Modify` permissions. -1. If the `Application Pool` user for Gateway is not listed: - 1. Click the `Edit...` button. - 1. Click the `Add...` button. - 1. Enter the username of the application pool user and click `OK`. - 1. In the `Permissions` section at the bottom, check `Modify`. - 1. Click `OK`. -1. If the `Application Pool` user for Gateway is listed but does not have permissions: - 1. Click the `Edit...` button. - 1. Select the `Application Pool` user. - 1. Check `Modify`. - 1. Click `OK`. - -#### Perform an IIS reset - -1. Open a Windows PowerShell (x64) window as administrator. -1. Run the following command: `iisreset`. -1. Wait for the action to complete. - -## Preserve installation files - -Ensure that the installation files are backed up or kept on the server, especially the scripts and config files that have been modified. This will make it easier to perform further actions in future, such as troubleshooting, certificate rollover, uninstallation, reinstallation and updates. - -## Next Steps? - -1. [Try it out][] - -[Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} -[Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} -[Configure CORTEX Gateway Installation Script]: {{< ref "#configure-cortex-gateway-installation-script" >}} -[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureInstallationScript" >}} -[CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} -[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} -[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} -[Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.LicensingRequirements" >}} -[Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} -[Try it out]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.TryItOut" >}} -[Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.InstallApplicationServer" >}} \ No newline at end of file diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md index 3155f3e4f..f9572bc7d 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md @@ -110,6 +110,10 @@ This guide describes how to install {{% ctx %}} Gateway on the Web Application S {{< section "/install-web-application-server/grant-gateway-user-additional-folder-permissions.md">}} +# Preserve installation files + +{{< section "/preserve-installation-files.md">}} + ## Next Steps? 1. [Setup {{% ctx %}} Gateway][Setup CORTEX Gateway] From e3e141d7e6e906a2816a9e8c2ab22c986a7fa46b Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Wed, 15 Nov 2023 11:52:31 +0000 Subject: [PATCH 09/21] Made some page title changes --- .../perform-debugger-installation.md | 4 ++-- .../perform-gateway-installation.md | 4 ++-- .../perform-debugger-installation.md | 4 ++-- .../perform-gateway-installation.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md index d008cb7f9..894b843ce 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md @@ -1,6 +1,6 @@ --- -title: "Perform Flow Debugger Installation" -linkTitle: "Perform Flow Debugger Installation" +title: "Install Flow Debugger" +linkTitle: "Install Flow Debugger" description: "Information about installing the Flow Debugger." weight: 20 --- diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md index 860a04177..6fff238fd 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md @@ -1,6 +1,6 @@ --- -title: "Perform Gateway Installation" -linkTitle: "Perform Gateway Installation" +title: "Upgrade Gateway" +linkTitle: "Upgrade Gateway" description: "Information about upgrading v7.2 {{% ctx %}} Gateway to include Innovation." weight: 30 --- diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md index 08291dadb..dabb9be5d 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md @@ -1,6 +1,6 @@ --- -title: "Perform Flow Debugger Installation" -linkTitle: "Perform Flow Debugger Installation" +title: "Install Flow Debugger" +linkTitle: "Install Flow Debugger" description: "Information about installing the Flow Debugger." weight: 20 --- diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md index f9572bc7d..2b474fa12 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md @@ -1,6 +1,6 @@ --- -title: "Perform Gateway Installation" -linkTitle: "Perform Gateway Installation" +title: "Install Gateway" +linkTitle: "Install Gateway" description: "Information about installing {{% ctx %}} Gateway." weight: 30 --- From 1856581a3b20c191b0f701ccdfa8a60f079487d4 Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Wed, 29 Nov 2023 14:08:32 +0000 Subject: [PATCH 10/21] fixed up broken URLs --- .../configure-debugger-installation-script.md | 1 + .../single-server-without-ha/try-it-out.md | 4 ++-- .../single-server-without-ha/install-application-server.md | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md index 9c6c38753..a7735fcc6 100644 --- a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md +++ b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md @@ -71,4 +71,5 @@ More advanced configuration (such as changing ports) can be undertaken by modify 1. Save and close `Cortex.Innovation.Install.ps1`. [Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.CertificateRequirements" >}} +[CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out.md index fac624592..5508df8dc 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/try-it-out.md @@ -7,7 +7,7 @@ weight: 60 # {{< param title >}} -This guide describes how to try out a new Innovation installation to make sure it is working. Please ensure that [Setup Gateway][] has been completed before taking these steps. +This guide describes how to try out a new Innovation installation to make sure it is working. Please ensure that the [Gateway Upgrade][] has been completed before taking these steps. ## Test Debugging Flows @@ -60,4 +60,4 @@ Test the platform by creating a new flow and executing it using the following st [Troubleshooting No Innovation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingNoInnovation" >}} [Troubleshooting No Publish]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingNoPublish" >}} [Troubleshooting Root Certificate Error]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingNoRootCertificate" >}} -[Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.SetupGateway" >}} +[Gateway Upgrade]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.AddInnovationTo72WebApplicationServer" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server.md index 58cf4012e..bf347167f 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-application-server.md @@ -60,5 +60,5 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc 1. [Install Web Application Server][] [Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.AntivirusExclusions" >}} -[Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallWebApplicationServer" >}} +[Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallWebApplicationServer" >}} [Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.Prerequisites" >}} From ab363218a55483101751739169149960c2f63efb Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Wed, 29 Nov 2023 19:54:39 +0000 Subject: [PATCH 11/21] fixed up a merge issue --- ...ll-application-and-loadbalancer-servers.md | 25 +- .../perform-gateway-installation.md | 233 ++---------------- .../prerequisites.md | 4 +- 3 files changed, 29 insertions(+), 233 deletions(-) diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md index 96062ddf7..d25ba890b 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md @@ -143,10 +143,10 @@ To check all necessary ports are free, follow these steps: -ClientCertificatePassword '#_186224203199039!168155035100255155162114088105027~037077176064169!055142133197216213014226219148063#' ` -Credential $Credential ` -LdapConnectionDetails @{ - Host= "LDAP://ldapserver.fqdn.com:389" - UseSsl= $false + Host= "LDAP://ldapserver.fqdn.com:389" + UseSsl= $false Username= "someUserName" - Password= '#_156218162004047!225018081008117174092221250099053~110194001237006!035122107175168133055021013201167#' + Password= '#_156218162004047!225018081008117174092221250099053~110194001237006!035122107175168133055021013201167#' } ` -AcceptEULA:$AcceptEula ` *>&1 | Tee-Object -FilePath "cortex-ha-install-log.txt" @@ -163,10 +163,10 @@ To check all necessary ports are free, follow these steps: -UseSelfSignedCertificates ` -Credential $Credential ` -LdapConnectionDetails @{ - Host= "LDAP://ldapserver.fqdn.com:389" - UseSsl= $false + Host= "LDAP://ldapserver.fqdn.com:389" + UseSsl= $false Username= "someUserName" - Password= '#_156218162004047!225018081008117174092221250099053~110194001237006!035122107175168133055021013201167#' + Password= '#_156218162004047!225018081008117174092221250099053~110194001237006!035122107175168133055021013201167#' } ` -AcceptEULA:$AcceptEula ` *>&1 | Tee-Object -FilePath "cortex-ha-install-log.txt" @@ -186,10 +186,10 @@ To check all necessary ports are free, follow these steps: -SkipLoadBalancer ` -Credential $Credential ` -LdapConnectionDetails @{ - Host= "LDAP://ldapserver.fqdn.com:389" - UseSsl= $false + Host= "LDAP://ldapserver.fqdn.com:389" + UseSsl= $false Username= "someUserName" - Password= '#_156218162004047!225018081008117174092221250099053~110194001237006!035122107175168133055021013201167#' + Password= '#_156218162004047!225018081008117174092221250099053~110194001237006!035122107175168133055021013201167#' } ` -AcceptEULA:$AcceptEula ` *>&1 | Tee-Object -FilePath "cortex-ha-install-log.txt" @@ -206,10 +206,10 @@ To check all necessary ports are free, follow these steps: -SkipLoadBalancer ` -Credential $Credential ` -LdapConnectionDetails @{ - Host= "LDAP://ldapserver.fqdn.com:389" - UseSsl= $false + Host= "LDAP://ldapserver.fqdn.com:389" + UseSsl= $false Username= "someUserName" - Password= '#_156218162004047!225018081008117174092221250099053~110194001237006!035122107175168133055021013201167#' + Password= '#_156218162004047!225018081008117174092221250099053~110194001237006!035122107175168133055021013201167#' } ` -AcceptEULA:$AcceptEula ` *>&1 | Tee-Object -FilePath "cortex-ha-install-log.txt" @@ -284,6 +284,7 @@ More advanced configuration (such as changing ports) can be undertaken by modify ```powershell .\Cortex.Innovation.Install.ps1 ``` + 1. Please read the End User Licence Agreement which can be found [here][Eula]. Once you agree to the terms, add the flag `-AcceptEULA` to the command entered above, e.g: ```powershell diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md index 1a9465e5e..c6b582788 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md @@ -1,168 +1,13 @@ --- -title: "Install the Web Application Server" -linkTitle: "Install Web Application Server" -description: "Information about installing the Web Application Server." -weight: 40 +title: "Install Gateway" +linkTitle: "Install Gateway" +description: "Information about installing {{% ctx %}} Gateway." +weight: 30 --- # {{% param title %}} -This guide describes how to install the Web Application Server. Please ensure that [Install Application Servers and Load Balancer][] has been completed before starting this installation. - -## Make Installation Artefacts Available - -{{% alert title="Note" %}} -We recommend that the single-node Service Fabric instance, used by {{% ctx %}} Gateway as a Debugger instance, and {{% ctx %}} Gateway are installed on the same Web Application Server. -{{% /alert %}} - -1. Copy the following artefacts to a folder on the machine: - * Cortex Innovation {{< version >}} - Block Packages.zip - * Cortex Innovation {{< version >}} - Gateway.zip - * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip - -1. Extract the `Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip` zip file to a folder with the same name. - -## Install Prerequisites - -### Licensing - -Ensure that a valid {{% ctx %}} licence file named `Cortex.lic` exists on the Web Application server, in the location `%ProgramData%\Cortex\Licences`. If it does not, follow the instructions located at [Licensing Requirements][]. - -### Install SQL Server or SQL Express - -1. Use one of the following installation guides to install SQL Server or SQL Server Express: - - * {{% ctx %}} Innovation - SQL Server 2016 Express Installation Guide - * {{% ctx %}} Innovation - SQL Server 2016 Installation Guide - * {{% ctx %}} Innovation - SQL Server 2019 Installation Guide - -### Get {{% ctx %}} Gateway Application Pool User - -A domain user account is required for the {{% ctx %}} Gateway application pool and must be created prior to performing the installation below. - -This user account is required to enable {{% ctx %}} Gateway to access the {{% ctx %}} database, with the following roles: - -* dbcreator -* public - -To add roles to database users take the following steps: - -1. Open SQL Server Management Studio on the Web Application Server and log in. -1. Expand the server node, then `Security` then `Logins`. -1. If the user that will run the {{% ctx %}} Gateway application pool is not in the list of logins, take the following steps, otherwise skip to step 4: - - 1. Right-click the `Logins` node and click `New Login...`. - 1. Enter the application pool user in the `Login name` box. - 1. On the left pane, click `Server Roles`. - 1. Check `public` and `dbcreator` - 1. Click `OK`. - -1. If the user that will run the {{% ctx %}} Gateway application pool is in the list of logins, take the following steps: - - 1. Right-click on the application pool user. - 1. Click `Properties`. - 1. On the left pane, click `Server Roles`. - 1. Check `public` and `dbcreator`. - 1. Click `OK`. - -In line with best practices, this account should not be given administrator rights, nor should it be used for any purposes other than those specified for {{% ctx %}} Gateway. - -### Grant folder permissions to the {{% ctx %}} Gateway Application Pool User - -The following folders require `Modify` permission to allow creating the `NuGet` folders and its `NuGet.Config` file within: - -* `C:\Windows\System32\config\systemprofile\AppData\Roaming` -* `C:\Windows\SysWOW64\config\systemprofile\AppData\Roaming` - -For each folder, perform the following steps: - -1. Navigate to the `AppData` folder. -1. Right-click on the `Roaming` folder and click `Properties`. -1. In the dialog, click the `Security` tab. -1. Check the `Application Pool` user that will be used for {{% ctx %}} Gateway is listed in the `Group or user names` and has `Modify` permissions. -1. If the `Application Pool` user that will be used for {{% ctx %}} Gateway is not listed: - 1. Click the `Edit...` button. - 1. Click the `Add...` button. - 1. Enter the username of the application pool user and click `OK`. - 1. In the `Permissions` section at the bottom, check `Modify`. - 1. Click `OK`. - 1. Click `Yes` to change the permission to the folder. -1. If the `Application Pool` user that will be used for {{% ctx %}} Gateway is listed but does not have permissions: - 1. Click the `Edit...` button. - 1. Select the `Application Pool` user. - 1. Check `Modify`. - 1. Click `OK`. - 1. Click `Yes` to change the permission to the folder. - -### Certificate Requirements - -{{% ctx %}} Gateway requires an X.509 SSL certificate to be installed on the Web Application Server. The certificate must have the following properties: - -* Enhanced Key Usage: `Server Authentication` and `Client Authentication` -* Subject Alternative Names (SAN): At minimum the FQDN of the server. It can also include NetBIOS Name, IP address, localhost, 127.0.0.1 - -If the user tries to navigate to an address not in the SAN list, then they will receive a certificate error. - -{{% alert title="Important" color="warning" %}} -Do not reuse any auto-generated self-signed certificates as they do not meet the requirements for Gateway. -
-Certificates, wildcard certificates and manually created self-signed certificates can be used. However, the latter are not recommended for production instances. -Details on how to create a self-signed certificate can be found at {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.CreateSelfSignedCertificates" title="Create Self-Signed Certificates" >}}. -
-It is possible to reuse the certificate used when {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PerformDebuggerInstallation" title="installing the Debugger" >}}, as long as it is not an auto-generated self-signed certificate; If doing so, you should {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyName" title="Assign a Certificate Friendly Name" >}} and set the `ImportCertificate` parameter to `$false` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScript" title="Configure CORTEX Gateway Installation Script" >}} to ensure use of the correct certificate and to prevent it from being overwritten. -{{% /alert %}} - -#### Import Root Certificate - -{{% alert title="Note" %}}This step is only required if using a self-signed certificate signed by your own Root Certificate e.g. OpenSSL. If this is not the case proceed to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ImportCertificateManually" title="Import Certificate Manually" >}} {{% /alert %}} - -This step must be carried out prior to the installation otherwise the URL validation will fail. In order to import the Root Certificate, ensure that the file is in a known location on this server and complete the following steps: - -1. Using Windows File Explorer navigate to the location of the Root Certificate file. -1. Double click on the Root Certificate file to import the certificate into the Windows Certificate Store. Perform the following steps: - - 1. Select `Local Machine` then click `Next`. - 1. Click `Next`. - 1. Enter the Export Password which the certificate was generated with then click `Next`. - 1. Select `Place all certificates in the following store`. - 1. Click `Browse…`. - 1. Select `Trusted Root Certification Authorities`, click `OK` then click `Next`. - 1. Click `Finish`. - 1. [Import][Import Certificate Manually] the X.509 SSL certificate. - -#### Import Certificate Manually - -{{% alert title="Note" %}}The certificate can be imported automatically by setting the `ImportCertificate` parameter to `$true` in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScript" title="Configure CORTEX Gateway Installation Script" >}}. If importing the certificate automatically proceed to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.PerformDebuggerInstallation" title="Perform Installation" >}}

If the certificate has previously been imported you must {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyName" title="assign a friendly name" >}}.{{% /alert %}} - -To import the certificate manually follow the below steps: - -1. Locate the certificate file on the machine and right-click on the file. -1. Select `Install Certificate`. -1. Follow the Wizard and when prompted, ensure you import it into the `Local Machine` store and not `Current User`. -1. Assign the imported certificate a [friendly name][Assign Certificate Friendly Name]. - -#### Assign Certificate Friendly Name - -Once the certificate has been imported, a `Friendly Name` should be assigned which will be used in the [Configure {{% ctx %}} Gateway Installation Script][Configure CORTEX Gateway Installation Script] to enable the installation script to identify the certificate to be used for the website: - -1. Click the Windows button (`Start`). -1. Type `certlm.msc` and press `Enter` to open the Certificate Manager dialog. -1. Expand `Personal` and select `Certificates`. -1. You should see your certificate in this store. -1. Right-click on the certificate and select `Properties`. -1. On the `General` tab in the `Friendly Name` text box, enter a name to be used for the certificate. -1. Click `OK`. - -## Perform Debugger Installation - -{{% alert title="Important" color="warning" %}} -{{< ctx >}} Gateway requires a local instance of the Application Server components to enable the debugging of flows. -{{% /alert %}} - -### Install Debugger - - -To install the components required for debugging, perform the steps detailed in [Install Application Server][] on the Web Application Server. +This guide describes how to install {{% ctx %}} Gateway on the Web Application Server. Please ensure that the [Flow Debugger installation][] has been completed before starting this installation. ## Perform Gateway Installation @@ -211,8 +56,8 @@ To install the components required for debugging, perform the steps detailed in |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used.

This will set the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used. It can be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This will set the `ServiceFabricApiGatewayBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.| |`DotNetFlowDebuggerEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the Web Application Server.

This will set the `DotNetFlowDebuggerEndpoint` value in the {{% ctx %}} Gateway web.config.| - |`DotNetFlowDebuggerBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Debugger on the Web Application Server][Install Application Server]; if so, this value must be configured to the one used.

This will set the `DotNetFlowDebuggerBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.| - |`DotNetFlowDebuggerBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Debugger on the Web Application Server][Install Application Server]; if so, this value must be configured to the one used. It can be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This will set the `DotNetFlowDebuggerBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.| + |`DotNetFlowDebuggerBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Debugger on the Web Application Server][Flow Debugger installation]; if so, this value must be configured to the one used.

This will set the `DotNetFlowDebuggerBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.| + |`DotNetFlowDebuggerBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Debugger on the Web Application Server][Flow Debugger installation]; if so, this value must be configured to the one used. It can be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This will set the `DotNetFlowDebuggerBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.| |`DotNetFlowDebuggerUsingSelfSignedCertificates` | Configure the value as `$false` if you are using valid CA certificates to secure the communication between {{% ctx %}} Gateway and the Debugger, `$true` if using self-signed certificates.

This will set the `DotNetFlowDebuggerUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`GatewayApplicationPoolUsername` | Replace `Domain\Username` with the user that should be used to run the {{% ctx %}} Gateway application pool as configured in [Get {{% ctx %}} Gateway Application Pool User][Get CORTEX Gateway Application Pool User].| |`WebRootFolder` | Replace this with the correct path for the Web Root Folder on the server. Typically this will be `C:\inetpub\wwwroot`.| @@ -263,75 +108,25 @@ To install the components required for debugging, perform the steps detailed in ### Grant additional folder permissions to the {{% ctx %}} Gateway Application Pool User -#### Cortex Blocks Provider Host folder - -Check that the {{% ctx %}} Gateway `Application Pool` user has rights to the `Cortex Blocks Provider Host folder` folder using the following steps: - -1. Navigate to `C:\ProgramData\Cortex` -1. Right-click on the `Cortex Blocks Provider Host` folder and click `Properties`. -1. In the dialog, click the `Security` tab. -1. Check the `Application Pool` user for Gateway is listed in the `Group or user names` and has `Modify` permissions. -1. If the `Application Pool` user for Gateway is not listed: - 1. Click the `Edit...` button. - 1. Click the `Add...` button. - 1. Enter the username of the application pool user and click `OK`. - 1. In the `Permissions` section at the bottom, check `Modify`. - 1. Click `OK`. -1. If the `Application Pool` user for Gateway is listed but does not have permissions: - 1. Click the `Edit...` button. - 1. Select the `Application Pool` user. - 1. Check `Modify`. - 1. Click `OK`. - -#### Repo folder - -Check that the {{% ctx %}} Gateway `Application Pool` user has rights to the `Repo` folder using the following steps: - -1. Check where the `Repo` folder is located - 1. Navigate to the `gateway` IIS folder (usually `%SystemDrive%\inetpub\wwwroot\Cortex\gateway`, e.g. `C:\inetpub\wwwroot\Cortex\gateway`) - 1. Open the `web.config` file. - 1. Find the value of the `connectionString` named `CortexRepositories` -1. Navigate to the `Repo` folder, not opening it. -1. Right-click on the `Repo` folder and click `Properties`. -1. In the dialog, click the `Security` tab. -1. Check the `Application Pool` user for Gateway is listed in the `Group or user names` and has `Modify` permissions. -1. If the `Application Pool` user for Gateway is not listed: - 1. Click the `Edit...` button. - 1. Click the `Add...` button. - 1. Enter the username of the application pool user and click `OK`. - 1. In the `Permissions` section at the bottom, check `Modify`. - 1. Click `OK`. -1. If the `Application Pool` user for Gateway is listed but does not have permissions: - 1. Click the `Edit...` button. - 1. Select the `Application Pool` user. - 1. Check `Modify`. - 1. Click `OK`. - -#### Perform an IIS reset - -1. Open a Windows PowerShell (x64) window as administrator. -1. Run the following command: `iisreset`. -1. Wait for the action to complete. +{{< section "/install-web-application-server/grant-gateway-user-additional-folder-permissions.md">}} ## Preserve installation files -Ensure that the installation files are backed up or kept on the server, especially the scripts and config files that have been modified. This will make it easier to perform further actions in future, such as troubleshooting, certificate rollover, uninstallation, reinstallation and updates. +{{< section "/preserve-installation-files.md">}} ## Next Steps? 1. [Setup {{% ctx %}} Gateway][Setup CORTEX Gateway] -[Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} +[Assign Certificate Friendly Name]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyNameNew" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} -[Configure CORTEX Gateway Installation Script]: {{< ref "#configure-cortex-gateway-installation-script" >}} [Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScript" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} -[Get CORTEX Gateway Application Pool User]: {{< ref "#get-cortex-gateway-application-pool-user" >}} -[Import Certificate Manually]: {{< ref "#import-certificate-manually" >}} -[Import Root Certificate]: {{< ref path="#import-root-certificate" >}} -[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} +[Flow Debugger installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.DebuggerInstallation" >}} +[Get CORTEX Gateway Application Pool User]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GetGatewayAppPoolUser" >}} +[Import Certificate Manually]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ImportCertificateManuallyNew" >}} +[Import Root Certificate]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ImportRootCertificate" >}} [Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.LicensingRequirements" >}} [Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} [Setup CORTEX Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.SetupGateway" >}} -[Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallApplicationServer" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md index 0b1745f53..ae64cd753 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md @@ -129,9 +129,9 @@ To import the certificate manually follow the below steps: ## Next Steps? -1. [Perform Flow Debugger Installation][] +1. [Install Flow Debugger][] [Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} [Import Certificate Manually]: {{< ref "#import-certificate-manually" >}} [Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} -[Perform Flow Debugger Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.DebuggerInstallation" >}} +[Install Flow Debugger]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.DebuggerInstallation" >}} From 8d336b81eb359f9be28aa1fd24315e7f09a42549 Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Wed, 29 Nov 2023 20:29:13 +0000 Subject: [PATCH 12/21] fixed up more merge issues --- .../install-application-and-loadbalancer-servers.md | 2 +- .../multiple-server-with-ha/prerequisites.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md index d25ba890b..9b6fa3f44 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md @@ -331,5 +331,5 @@ More advanced configuration (such as changing ports) can be undertaken by modify [Prerequisites for adding Innovation to v7.2]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.Prerequisites" >}} [SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} [Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} -[Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScript" >}} +[Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} [Upgrade v7.2 Gateway to Include Innovation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AddInnovationTo72WebApplicationServer" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites.md index 34f5970c8..6ee92e9aa 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/prerequisites.md @@ -311,7 +311,7 @@ Application Servers and Load Balancer server are installed in the same way regar [Port Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.PortRequirements" >}} [Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} -[Upgrading Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScript" >}} +[Upgrading Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} [Architecture]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.Architecture" >}} [Recommended Architecture]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.RecommendedArchitecture" >}} [Minimum Architecture]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.MinimumArchitecture" >}} From 5b63938f77105c0b68822afbe3432b6179b7d151 Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Thu, 30 Nov 2023 09:30:39 +0000 Subject: [PATCH 13/21] Minor change to documentation --- .../perform-debugger-installation.md | 10 ---------- .../perform-gateway-installation.md | 5 +++++ 2 files changed, 5 insertions(+), 10 deletions(-) diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md index dabb9be5d..497f4e3fb 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md @@ -56,16 +56,6 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc 1. [Perform Gateway Installation][] [Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AntivirusExclusions" >}} -[Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} -[Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} -[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScript" >}} -[CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} -[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} -[Get CORTEX Gateway Application Pool User]: {{< ref "#get-cortex-gateway-application-pool-user" >}} -[Import Certificate Manually]: {{< ref "#import-certificate-manually" >}} [Import Root Certificate]: {{< ref path="#import-root-certificate" >}} -[Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallApplicationServer" >}} -[Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} [Perform Gateway Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GatewayInstallation" >}} -[Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} [web application server prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.WebApplicationServerPrerequisites" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md index c6b582788..6949b1179 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md @@ -11,6 +11,10 @@ This guide describes how to install {{% ctx %}} Gateway on the Web Application S ## Perform Gateway Installation +### Certificate Requirements + +It is possible for {{% ctx %}} Gateway to reuse the certificate used when [installing the Flow Debugger][Flow Debugger installation], as long as it was not an auto-generated self-signed certificate; If doing so, you must [Assign a Certificate Friendly Name][Assign Certificate Friendly Name] and set the `ImportCertificate` parameter to `$false` when [configuring the {{% ctx %}} Gateway Installation Script][Install Gateway] to ensure use of the correct certificate and to prevent it from being overwritten. + ### Configure {{% ctx %}} Gateway Installation Script 1. In the `Cortex Innovation {{< version >}} - Web App Server Install Scripts` folder, locate the `Cortex.Innovation.Install.Gateway.ps1` script and open it with a text editor. @@ -127,6 +131,7 @@ This guide describes how to install {{% ctx %}} Gateway on the Web Application S [Get CORTEX Gateway Application Pool User]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GetGatewayAppPoolUser" >}} [Import Certificate Manually]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ImportCertificateManuallyNew" >}} [Import Root Certificate]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ImportRootCertificate" >}} +[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} [Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.LicensingRequirements" >}} [Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} [Setup CORTEX Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.SetupGateway" >}} From defc09293afdb08fc751824536bcb903bd1d4d1b Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Thu, 30 Nov 2023 09:56:30 +0000 Subject: [PATCH 14/21] Fixed up merge issue --- .../configure-debugger-installation-script.md | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md index 166d4c918..a390c8ce4 100644 --- a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md +++ b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md @@ -7,18 +7,18 @@ -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` -ApiGatewayBasicAuthUsername "BasicAuthUser" ` - -ApiGatewayBasicAuthPassword "ADA9883B11BD4CDC908B8131B57944A4" ` + -ApiGatewayBasicAuthPassword '#_065077199197085!212123173135087074174142102155007175102029143220132038175026114248243207204119030125106032237087162060168108135168241247037070081~187087056217118!069132229129134129097089241180163#' ` -CustomerName "Customer1" ` -ApplicationServerIPv4Addresses @("192.168.1.1") ` -ServerCertificatePath "C:\Install\Certificates\cert.pfx" ` - -ServerCertificatePassword "myPassword" ` + -ServerCertificatePassword '#_186224203199039!168155035100255155162114088105027~037077176064169!055142133197216213014226219148063#' ` -SkipLoadBalancer ` -Credential $Credential ` -LdapConnectionDetails @{ - Host= "LDAP://ldapserver.fqdn.com:389" - UseSsl= $false + Host= "LDAP://ldapserver.fqdn.com:389" + UseSsl= $false Username= "someUserName" - Password= "somePassword" + Password= '#_156218162004047!225018081008117174092221250099053~110194001237006!035122107175168133055021013201167#' } ` -AcceptEULA:$AcceptEula ` *>&1 | Tee-Object -FilePath "cortex-app-install-log.txt" @@ -28,17 +28,17 @@ -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` -ApiGatewayBasicAuthUsername "BasicAuthUser" ` - -ApiGatewayBasicAuthPassword "ADA9883B11BD4CDC908B8131B57944A4" ` + -ApiGatewayBasicAuthPassword '#_065077199197085!212123173135087074174142102155007175102029143220132038175026114248243207204119030125106032237087162060168108135168241247037070081~187087056217118!069132229129134129097089241180163#' ` -CustomerName "Customer1" ` -ApplicationServerIPv4Addresses @("192.168.1.1") ` -UseSelfSignedCertificates ` -SkipLoadBalancer ` -Credential $Credential ` -LdapConnectionDetails @{ - Host= "LDAP://ldapserver.fqdn.com:389" - UseSsl= $false + Host= "LDAP://ldapserver.fqdn.com:389" + UseSsl= $false Username= "someUserName" - Password= "somePassword" + Password= '#_156218162004047!225018081008117174092221250099053~110194001237006!035122107175168133055021013201167#' } ` -AcceptEULA:$AcceptEula ` *>&1 | Tee-Object -FilePath "cortex-app-install-log.txt" @@ -49,20 +49,20 @@ |----------------------------------------------|-------------| |`AppServicesPath` | Configure this value with the location of the App Services zip file on the server. | |`BlockPackagesPath` | Configure this value with the location of the Block Packages zip file on the server. | - |`ApiGatewayBasicAuthUsername` | Configure this value with a username that can be used to make HTTPS requests to the API Gateway Service using Basic Authentication (e.g. starting flows). This username will be used by Gateway for all HTTPS requests to the API Gateway Service.

For security reasons it is recommended that the default value `BasicAuthUser` should be changed.

This value will be needed [later, when installing Gateway][Install Gateway].

This username can also be used by external services for HTTPS requests to the API Gateway Service but is not recommended; these requests should use an OAuth2 session for an authorised Active Directory user.| - |`ApiGatewayBasicAuthPassword` | Configure this value with the password for the username specified for `ApiGatewayBasicAuthUsername`.

This password should be [{{% ctx %}} Encrypted][CORTEX Encrypted]. For security reasons it is recommended that the default value `ADA9883B11BD4CDC908B8131B57944A4` should be changed.

This value will be needed [later, when installing Gateway][Install Gateway].| + |`ApiGatewayBasicAuthUsername` | Configure this value with a username that can be used to make HTTPS requests to the API Gateway Service using Basic Authentication (e.g. starting flows). This username will be used by Gateway for all HTTPS requests to the API Gateway Service.

For security reasons it is recommended that the default value `BasicAuthUser` should be changed.

This value will be needed later, [when installing Gateway][Install Gateway].

This username can also be used by external services for HTTPS requests to the API Gateway Service but is not recommended; these requests should use an OAuth2 session for an authorised Active Directory user.{{< alert type="note" title="Note" >}} This parameter can be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| + |`ApiGatewayBasicAuthPassword` | Configure this value with the password for the username specified for `ApiGatewayBasicAuthUsername`.

For security reasons it is recommended that the default value should be changed.

This value will be needed later, [when installing Gateway][Install Gateway].{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| |`CustomerName` | A name identifying the platform being installed. This must have no spaces or symbols. It will be appended to the node names that are displayed in Service Fabric Explorer. | |`ApplicationServerIPv4Addresses` | The IPv4 address of the server.| |`ServerCertificatePath` | The local path of a .PFX certificate file on the server. Environment variables cannot be used.

This is only needed if installing with CA Certificates (Recommended). The certificate should meet the [Certificate Requirements][].

This certificate will be used for:
  • Securing communication between the Application Services.
  • Allowing Application Services to identify themselves to clients such as Gateway.
  • Preventing unauthorised nodes from joining the single node cluster.
  • Connecting to Service Fabric Explorer from each of the Application Servers.
{{< alert type="warning" title="Warning" >}}It is critical to set a reminder to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.RolloverCertificates" title="update certificates" >}} in good time before they expire. If they expire then the platform will cease to function and {{< ahref path="Cortex.ServicePortal.MainDoc" title="CORTEX Service Portal" >}} must be contacted for support.{{< /alert >}}| - |`ServerCertificatePassword` | The password for the .PFX certificate file specified in `ServerCertificatePath`.

This is only needed if installing with CA Certificates (Recommended).| + |`ServerCertificatePassword` | The password for the .PFX certificate file specified in `ServerCertificatePath`.

This is only needed if installing with CA Certificates (Recommended).{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| |`UseSelfSignedCertificates` | Installs Application Services and required infrastructure using generated Self-Signed Certificates rather than CA Certificates.

Not recommended for production use. | |`SkipLoadBalancer` | Installs Application Services and required infrastructure without installing a load balancer. | |`Credential` | The credentials of the user which will be used to perform remote operations on the server. It must be a domain user that is a member of the local Administrators group on the server.

This does not need to be changed, a prompt will appear to enter this information when the script is run. | - |`LdapConnectionDetails` | The connection details to the LDAP server.

This must be configured with a valid `Host`, `Username`, `Password`, and whether the LDAP server uses SSL using `UseSsl`. {{< alert type="note" title="Note" >}}All fields but `UseSsl` can be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | + |`LdapConnectionDetails` | The connection details to the LDAP server.

This must be configured with a valid `Host`, `Username`, `Password`, and whether the LDAP server uses SSL using `UseSsl`. {{< alert type="note" title="Note" >}}The parameters `Host` and `Username` can be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}. The parameter `Password` must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | |`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. | |`FilePath` | The filename that installation logs are written to. If this should be written to a different location than where the installation files are then a full path should be specified. | - The `ApiGatewayBasicAuthUsername` and `ApiGatewayBasicAuthPassword` will be needed [later, when installing Gateway][Install Gateway]. + The `ApiGatewayBasicAuthUsername` and `ApiGatewayBasicAuthPassword` will be needed later, [when installing Gateway][Install Gateway]. {{% alert title="Note" %}} More advanced configuration (such as changing ports) can be undertaken by modifying the `Cortex.Innovation.Install.Config.json` file but this shouldn't be required for most installations. More information about this can be found at {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.AdvancedConfigSingleServer" title="Advanced Application Server and Load Balancer Configuration Changes" >}}. From 46b6f59a0afcb41b24b8fc811e5083f75c8c65f7 Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Thu, 30 Nov 2023 10:41:43 +0000 Subject: [PATCH 15/21] Fixed further merge issues --- .../configure-debugger-installation-script.md | 4 +++- .../configure-debugger-installation-script.md | 4 +++- .../perform-gateway-installation.md | 16 +++++++++------- 3 files changed, 15 insertions(+), 9 deletions(-) diff --git a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md index a390c8ce4..8e0f1502d 100644 --- a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md +++ b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md @@ -45,6 +45,8 @@ {{< /tab >}} {{< /tabpane >}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirements" title="Encryption Requirements" >}} steps.{{% /alert %}} + | Name | Description | |----------------------------------------------|-------------| |`AppServicesPath` | Configure this value with the location of the App Services zip file on the server. | @@ -72,4 +74,4 @@ More advanced configuration (such as changing ports) can be undertaken by modify [Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.CertificateRequirements" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} -[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} \ No newline at end of file +[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.EncryptionRequirements" >}}[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} \ No newline at end of file diff --git a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md index dc1ff955b..35394638a 100644 --- a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md +++ b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md @@ -45,6 +45,8 @@ {{< /tab >}} {{< /tabpane >}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirements" title="Encryption Requirements" >}} steps.{{% /alert %}} + | Name | Description | |----------------------------------------------|-------------| |`AppServicesPath` | Configure this value with the location of the App Services zip file on the server. | @@ -72,4 +74,4 @@ More advanced configuration (such as changing ports) can be undertaken by modify [Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.CertificateRequirements" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} -[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} +[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.EncryptionRequirements" >}}[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md index 6949b1179..91f47c347 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md @@ -30,10 +30,10 @@ It is possible for {{% ctx %}} Gateway to reuse the certificate used when [insta -ServiceFabricApiGatewayEndpoint "https://server.domain.com/" ` -ServiceFabricUsingSelfSignedCertificates $false ` -ServiceFabricApiGatewayBasicAuthUsername "BasicAuthUser" ` - -ServiceFabricApiGatewayBasicAuthPassword 'ADA9883B11BD4CDC908B8131B57944A4' ` - -DotNetFlowDebuggerEndpoint "https://server.domain.com:8722/api/" ` + -ServiceFabricApiGatewayBasicAuthPassword '#_065077199197085!212123173135087074174142102155007175102029143220132038175026114248243207204119030125106032237087162060168108135168241247037070081~187087056217118!069132229129134129097089241180163#' ` + -DotNetFlowDebuggerEndpoint 'https://server.domain.com:8722/api/' ` -DotNetFlowDebuggerBasicAuthUsername "BasicAuthUser" ` - -DotNetFlowDebuggerBasicAuthPassword 'ADA9883B11BD4CDC908B8131B57944A4' ` + -DotNetFlowDebuggerBasicAuthPassword '#_065077199197085!212123173135087074174142102155007175102029143220132038175026114248243207204119030125106032237087162060168108135168241247037070081~187087056217118!069132229129134129097089241180163#' ` -DotNetFlowDebuggerUsingSelfSignedCertificates $false ` -GatewayApplicationPoolUsername "Domain\Username" ` -WebRootFolder "C:\inetpub\wwwroot" ` @@ -48,6 +48,8 @@ It is possible for {{% ctx %}} Gateway to reuse the certificate used when [insta *>&1 | Tee-Object -FilePath "cortex-gateway-install-log.txt" ``` + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirements" title="Encryption Requirements" >}} steps.{{% /alert %}} + | Name | Description | |------------------------------------------------|-------------| |`GatewayPackagePath` | Configure this value with the location of the `Cortex Innovation {{< version >}} - Gateway.zip` file on the installation server. | @@ -57,11 +59,11 @@ It is possible for {{% ctx %}} Gateway to reuse the certificate used when [insta |`FeatureFlags` | Replace `InnovationId` with the {{% ctx %}} Innovation feature identifier, which should have been provided by {{% ctx %}} when fulfilling the [Licensing Requirements][], if it wasn't it should be requested using [{{% ctx %}} Service Portal][CORTEX Service Portal].

This will set the `FeatureFlags` value in the Gateway web.config.| |`ServiceFabricApiGatewayEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the Load Balancer Server. The port should be specified if it is not the default HTTPS port (443), and there must be a trailing slash, e.g. `https://server.domain.com/` or `https://server.domain.com:8722/`.

This will set the `ServiceFabricApiGatewayEndpoint` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricUsingSelfSignedCertificates` | Configure the value as `$false` if you used valid CA certificates when [installing the Application Servers][Configure Installation Script], `$true` if you used self-signed certificates.

This will set the `ServiceFabricUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| - |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used.

This will set the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.| - |`ServiceFabricApiGatewayBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used. It can be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This will set the `ServiceFabricApiGatewayBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.| + |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used.

This will set the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter can be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| + |`ServiceFabricApiGatewayBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used.

This will set the `ServiceFabricApiGatewayBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| |`DotNetFlowDebuggerEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the Web Application Server.

This will set the `DotNetFlowDebuggerEndpoint` value in the {{% ctx %}} Gateway web.config.| - |`DotNetFlowDebuggerBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Debugger on the Web Application Server][Flow Debugger installation]; if so, this value must be configured to the one used.

This will set the `DotNetFlowDebuggerBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.| - |`DotNetFlowDebuggerBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Debugger on the Web Application Server][Flow Debugger installation]; if so, this value must be configured to the one used. It can be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This will set the `DotNetFlowDebuggerBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.| + |`DotNetFlowDebuggerBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Debugger on the Web Application Server][Flow Debugger installation]; if so, this value must be configured to the one used.

This will set the `DotNetFlowDebuggerBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter can be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| + |`DotNetFlowDebuggerBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Debugger on the Web Application Server][Flow Debugger installation]; if so, this value must be configured to the one used.

This will set the `DotNetFlowDebuggerBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| |`DotNetFlowDebuggerUsingSelfSignedCertificates` | Configure the value as `$false` if you are using valid CA certificates to secure the communication between {{% ctx %}} Gateway and the Debugger, `$true` if using self-signed certificates.

This will set the `DotNetFlowDebuggerUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`GatewayApplicationPoolUsername` | Replace `Domain\Username` with the user that should be used to run the {{% ctx %}} Gateway application pool as configured in [Get {{% ctx %}} Gateway Application Pool User][Get CORTEX Gateway Application Pool User].| |`WebRootFolder` | Replace this with the correct path for the Web Root Folder on the server. Typically this will be `C:\inetpub\wwwroot`.| From a10687ca6c01130825ec22a087b77b0730822b8f Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Thu, 30 Nov 2023 11:11:32 +0000 Subject: [PATCH 16/21] excluded nssm url from htmltest due to failures for multiple checks --- .htmltest.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.htmltest.yml b/.htmltest.yml index e3844a0f0..e0c63400d 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -19,6 +19,7 @@ IgnoreURLs: - "https://learn.microsoft.com/.*" - "https://fonts.googleapis.com.*" - "https://fonts.gstatic.com.*" +- "https://nssm.cc/" IgnoreDirs: - "docs/?.*/_print/" - "docs/?.*/_shared/" From 365c63deb983af08a83079a19a91b13d146f2041 Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Thu, 30 Nov 2023 11:48:40 +0000 Subject: [PATCH 17/21] fixed some review comments --- content/en/docs/2023.11/_shared/currentVersion.md | 2 +- .../perform-gateway-installation.md | 4 ++-- .../multiple-server-with-ha/setup-gateway.md | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/docs/2023.11/_shared/currentVersion.md b/content/en/docs/2023.11/_shared/currentVersion.md index aed7c22fe..16c72aaf5 100644 --- a/content/en/docs/2023.11/_shared/currentVersion.md +++ b/content/en/docs/2023.11/_shared/currentVersion.md @@ -1 +1 @@ -2023.9 \ No newline at end of file +2023.11 \ No newline at end of file diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md index 91f47c347..1bce9c6e6 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md @@ -31,7 +31,7 @@ It is possible for {{% ctx %}} Gateway to reuse the certificate used when [insta -ServiceFabricUsingSelfSignedCertificates $false ` -ServiceFabricApiGatewayBasicAuthUsername "BasicAuthUser" ` -ServiceFabricApiGatewayBasicAuthPassword '#_065077199197085!212123173135087074174142102155007175102029143220132038175026114248243207204119030125106032237087162060168108135168241247037070081~187087056217118!069132229129134129097089241180163#' ` - -DotNetFlowDebuggerEndpoint 'https://server.domain.com:8722/api/' ` + -DotNetFlowDebuggerEndpoint "https://server.domain.com:8722/api/" ` -DotNetFlowDebuggerBasicAuthUsername "BasicAuthUser" ` -DotNetFlowDebuggerBasicAuthPassword '#_065077199197085!212123173135087074174142102155007175102029143220132038175026114248243207204119030125106032237087162060168108135168241247037070081~187087056217118!069132229129134129097089241180163#' ` -DotNetFlowDebuggerUsingSelfSignedCertificates $false ` @@ -73,7 +73,7 @@ It is possible for {{% ctx %}} Gateway to reuse the certificate used when [insta |`CertificateFriendlyName` | Replace this with the friendly name that you would like to be allocated to the certificate.

If `ImportCertificate` is set to `$false` this must be [assigned][Assign Certificate Friendly Name] prior to running the installation and the Friendly Name used must be specified to allow the website to use the correct certificate.| |`ConfigureSiteRedirect` | If the site hosting the {{% ctx %}} Gateway web application is a newly created Cortex site or an existing site that doesn’t have its own content, it is recommended to redirect the site URL to the {{% ctx %}} Gateway web application URL. The default behaviour of the script is to create a URL Rewrite redirect rule to achieve this.

To skip this rule creation change the value to `$false`.| |`ApplySecurityMeasures` | Change this from `$true` to `$false` if you do not require the Recommended [Security Best Practices][] to be implemented as part of the installation process.| - |`UsingWindowsDefender` | Change this from `$true` to `$false` if you are not using the Windows Defender firewall.

If Windows Defender is not being used but an alterntive firewall is, it must be configured to allow communication inbound via TCP on the port configured for HTTPS (usually 443).| + |`UsingWindowsDefender` | Change this from `$true` to `$false` if you are not using the Windows Defender firewall.

If Windows Defender is not being used but an alternative firewall is, it must be configured to allow communication inbound via TCP on the port configured for HTTPS (usually 443).| |`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. | |`FilePath` | The filename that installation logs are written to. If this should be written to a different location than where the installation files are then a full path should be specified. | diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/setup-gateway.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/setup-gateway.md index cc61ed586..60ce3e445 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/setup-gateway.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/setup-gateway.md @@ -7,7 +7,7 @@ weight: 50 # {{% param title %}} -This guide describes how to setup Gateway. Please ensure that [Perform Gateway Installation][] has been completed before taking these steps. +This guide describes how to setup Gateway. Please ensure that the [Gateway Installation][] has been completed before taking these steps. ## Gateway Initial Setup @@ -88,5 +88,5 @@ Once Gateway has been configured, if you wish to encrypt the databases using [Tr [Account Details]: {{< ref "#account-details" >}} [LDAP Connection]: {{< ref "#ldap-connection" >}} [LDAP Authorisation]: {{< ref "#ldap-authorisation" >}} -[Perform Gateway Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GatewayInstallation" >}} +[Gateway Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GatewayInstallation" >}} [Transparent Data Encryption]: {{< url path="MSDocs.SqlServer.TransparentDataEncryption" >}} From b9361288f7c1c8d0908dff17108fd27bfeaded03 Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Thu, 30 Nov 2023 12:16:18 +0000 Subject: [PATCH 18/21] Fixed further comments from Review --- .../install-application-and-loadbalancer-servers.md | 4 ++-- .../install-web-application-server/_index.md | 8 ++++---- .../perform-debugger-installation.md | 4 ++-- .../install-web-application-server/prerequisites.md | 4 ++-- .../install-application-server.md | 4 ++-- .../perform-debugger-installation.md | 4 ++-- .../perform-gateway-installation.md | 4 ++-- .../install-web-application-server.md | 4 ++-- 8 files changed, 18 insertions(+), 18 deletions(-) diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md index 9b6fa3f44..edd460dc4 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers.md @@ -317,7 +317,7 @@ More advanced configuration (such as changing ports) can be undertaken by modify ## Next Steps? -1. [Upgrade v7.2 Gateway to Include Innovation][] +1. [Upgrade the Web Application Server][] [alternative load balancer]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AltLoadBalancer" >}} [Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AntivirusExclusions" >}} @@ -332,4 +332,4 @@ More advanced configuration (such as changing ports) can be undertaken by modify [SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} [Troubleshooting During Installation]: {{< url path="Cortex.Reference.Troubleshooting.Installation.TroubleshootingDuringInstallation" >}} [Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} -[Upgrade v7.2 Gateway to Include Innovation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AddInnovationTo72WebApplicationServer" >}} +[Upgrade the Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AddInnovationTo72WebApplicationServer" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/_index.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/_index.md index 61fc85dee..de8fd65f8 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/_index.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/_index.md @@ -1,10 +1,10 @@ --- -title: "Install the Web Application Server" -linkTitle: "Install Web Application Server" -description: "Information about installing the Web Application Server." +title: "Upgrade the Web Application Server" +linkTitle: "Upgrade Web Application Server" +description: "Information about upgrading the Web Application Server to include Innovation." weight: 40 --- -This guide describes how to upgrade {{% ctx %}} Gateway on v7.2 to include Innovation. Please ensure that [Install Application Servers and Load Balancer][] has been completed before starting this installation. These steps assume that the v7.2 version of Gateway and its prerequisites have already been installed. +This guide describes how to upgrade the v7.2 Web Application Server to Include Innovation. Please ensure that [Install Application Servers and Load Balancer][] has been completed before starting this installation. These steps assume that the v7.2 version of Gateway and its prerequisites have already been installed. [Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md index 894b843ce..dbbcf7358 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md @@ -53,8 +53,8 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc ## Next Steps? -1. [Perform Gateway Installation][] +1. [Upgrade Gateway][] [Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AntivirusExclusions" >}} -[Perform Gateway Installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.GatewayInstallation" >}} +[Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.GatewayInstallation" >}} [web application server prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.WebApplicationServerPrerequisites" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/prerequisites.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/prerequisites.md index 88273a26b..89063d75b 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/prerequisites.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/prerequisites.md @@ -45,9 +45,9 @@ The Flow Debugger also requires an X.509 SSL certificate to be installed on the ## Next Steps? -1. [Perform Flow Debugger Installation][] +1. [Install Flow Debugger][] [Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} [Configure CORTEX Gateway Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} [Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} -[Perform Flow Debugger Installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.DebuggerInstallation" >}} +[Install Flow Debugger]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.DebuggerInstallation" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md index e3306e43b..e956aa8c2 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-application-server.md @@ -57,8 +57,8 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc ## Next Steps? -1. [Install Web Application Server][] +1. [Upgrade v7.2 Gateway to Include Innovation][] [Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.AntivirusExclusions" >}} -[Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.AddInnovationTo72WebApplicationServer" >}} +[Upgrade v7.2 Gateway to Include Innovation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.AddInnovationTo72WebApplicationServer" >}} [Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.Prerequisites" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md index 497f4e3fb..e200454ac 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation.md @@ -53,9 +53,9 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc ## Next Steps? -1. [Perform Gateway Installation][] +1. [Install Gateway][] [Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AntivirusExclusions" >}} [Import Root Certificate]: {{< ref path="#import-root-certificate" >}} -[Perform Gateway Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GatewayInstallation" >}} +[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GatewayInstallation" >}} [web application server prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.WebApplicationServerPrerequisites" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md index 1bce9c6e6..3bfdeda4d 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md @@ -122,7 +122,7 @@ It is possible for {{% ctx %}} Gateway to reuse the certificate used when [insta ## Next Steps? -1. [Setup {{% ctx %}} Gateway][Setup CORTEX Gateway] +1. [Setup Gateway][] [Assign Certificate Friendly Name]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AssignCertificateFriendlyNameNew" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} @@ -136,4 +136,4 @@ It is possible for {{% ctx %}} Gateway to reuse the certificate used when [insta [Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} [Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.LicensingRequirements" >}} [Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} -[Setup CORTEX Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.SetupGateway" >}} +[Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.SetupGateway" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server.md index 595c8e1c8..84601d335 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server.md @@ -307,7 +307,7 @@ Ensure that the installation files are backed up or kept on the server, especial ## Next Steps? -1. [Setup {{% ctx %}} Gateway][Setup CORTEX Gateway] +1. [Setup Gateway][] [Assign Certificate Friendly Name]: {{< ref "#assign-certificate-friendly-name" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} @@ -322,4 +322,4 @@ Ensure that the installation files are backed up or kept on the server, especial [Licensing Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.LicensingRequirements" >}} [Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirements" >}} [Security Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} -[Setup CORTEX Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.SetupGateway" >}} +[Setup Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.SetupGateway" >}} From ba95d15935a84746a09618847c1e18d46e6d426a Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Thu, 30 Nov 2023 12:34:03 +0000 Subject: [PATCH 19/21] Further comments resolved following review --- .../add-innovation-to-7.2/configure-installation-script.md | 2 +- .../add-innovation-to-7.2/assign-certificate-friendly-name.md | 2 +- .../configure-debugger-installation-script.md | 3 ++- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/content/en/docs/2023.11/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md b/content/en/docs/2023.11/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md index 3b7324575..642a92f85 100644 --- a/content/en/docs/2023.11/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md +++ b/content/en/docs/2023.11/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md @@ -72,6 +72,6 @@ More advanced configuration (such as changing ports) can be undertaken by modify 1. Save and close `Cortex.Innovation.Install.ps1`. -[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.CertificateRequirements" >}} +[Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.CertificateRequirements" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScript" >}} \ No newline at end of file diff --git a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/assign-certificate-friendly-name.md b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/assign-certificate-friendly-name.md index 36dd1b3f6..e39dc70a4 100644 --- a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/assign-certificate-friendly-name.md +++ b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/assign-certificate-friendly-name.md @@ -8,4 +8,4 @@ Once the certificate has been imported, a `Friendly Name` should be assigned whi 1. On the `General` tab in the `Friendly Name` text box, enter a name to be used for the certificate. 1. Click `OK`. -[Configure CORTEX Gateway Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} +[Configure CORTEX Gateway Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} diff --git a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md index 35394638a..241447438 100644 --- a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md +++ b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md @@ -74,4 +74,5 @@ More advanced configuration (such as changing ports) can be undertaken by modify [Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.CertificateRequirements" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} -[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.EncryptionRequirements" >}}[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} +[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.EncryptionRequirements" >}} +[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} From 1adcc54842284d8b6f4086f0279ab3e5ae667527 Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Thu, 30 Nov 2023 13:27:27 +0000 Subject: [PATCH 20/21] final merge issues resolved --- .../configure-debugger-installation-script.md | 2 +- .../install-web-application-server.md | 8 ++++---- .../perform-gateway-installation.md | 2 +- .../install-web-application-server.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md index 241447438..bd83a68e8 100644 --- a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md +++ b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md @@ -45,7 +45,7 @@ {{< /tab >}} {{< /tabpane >}} - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirements" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.EncryptionRequirements" title="Encryption Requirements" >}} steps.{{% /alert %}} | Name | Description | |----------------------------------------------|-------------| diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server.md index 69915ac19..95fca4905 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/install-web-application-server.md @@ -87,10 +87,10 @@ A Friendly Name should be assigned to the certificate being used for the Cortex -ServiceFabricApiGatewayEndpoint "https://server.domain.com:8722/" ` -ServiceFabricUsingSelfSignedCertificates $false ` -ServiceFabricApiGatewayBasicAuthUsername "BasicAuthUser" ` - -ServiceFabricApiGatewayBasicAuthPassword "#_065077199197085!212123173135087074174142102155007175102029143220132038175026114248243207204119030125106032237087162060168108135168241247037070081~187087056217118!069132229129134129097089241180163#" ` + -ServiceFabricApiGatewayBasicAuthPassword '#_065077199197085!212123173135087074174142102155007175102029143220132038175026114248243207204119030125106032237087162060168108135168241247037070081~187087056217118!069132229129134129097089241180163#' ` -DotNetFlowDebuggerEndpoint "https://server.domain.com:8722/api/" ` -DotNetFlowDebuggerBasicAuthUsername "BasicAuthUser" ` - -DotNetFlowDebuggerBasicAuthPassword "#_065077199197085!212123173135087074174142102155007175102029143220132038175026114248243207204119030125106032237087162060168108135168241247037070081~187087056217118!069132229129134129097089241180163#" ` + -DotNetFlowDebuggerBasicAuthPassword '#_065077199197085!212123173135087074174142102155007175102029143220132038175026114248243207204119030125106032237087162060168108135168241247037070081~187087056217118!069132229129134129097089241180163#' ` -DotNetFlowDebuggerUsingSelfSignedCertificates $false ` -GatewayApplicationPoolUsername "Domain\Username" ` -WebRootFolder "C:\inetpub\wwwroot" ` @@ -114,10 +114,10 @@ A Friendly Name should be assigned to the certificate being used for the Cortex |`ServiceFabricApiGatewayEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the server. The port should be specified as `8722` and there must be a trailing slash, e.g. `https://server.domain.com:8722/`.

This will overwrite the `ServiceFabricApiGatewayEndpoint` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricUsingSelfSignedCertificates` | Configure the value as `$false` if you used valid CA certificates when [installing the Application Server][Configure Installation Script], `$true` if you used self-signed certificates.

This will overwrite the `ServiceFabricUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Server][Configure Installation Script]; if so, this value must be configured to the one used.

This will overwrite the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter can be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| - |`ServiceFabricApiGatewayBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Application Server][Configure Installation Script]; if so, this value must be configured to the one used. It can be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This will overwrite the `ServiceFabricApiGatewayBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| + |`ServiceFabricApiGatewayBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Application Server][Configure Installation Script]; if so, this value must be configured to the one used.

This will overwrite the `ServiceFabricApiGatewayBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| |`DotNetFlowDebuggerEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the server.

This will overwrite the `DotNetFlowDebuggerEndpoint` value in the {{% ctx %}} Gateway web.config.| |`DotNetFlowDebuggerBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Debugger on the Web Application Server][Install Application Server]; if so, this value must be configured to the one used.

This will overwrite the `DotNetFlowDebuggerBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter can be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| - |`DotNetFlowDebuggerBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Debugger on the Web Application Server][Install Application Server]; if so, this value must be configured to the one used. It can be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This will overwrite the `DotNetFlowDebuggerBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| + |`DotNetFlowDebuggerBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Debugger on the Web Application Server][Install Application Server]; if so, this value must be configured to the one used.

This will overwrite the `DotNetFlowDebuggerBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| |`DotNetFlowDebuggerUsingSelfSignedCertificates` | Configure the value as `$false` if you are using valid CA certificates to secure the communication between {{% ctx %}} Gateway and the Debugger, `$true` if using self-signed certificates.

This will overwrite the `DotNetFlowDebuggerUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`GatewayApplicationPoolUsername` | Replace `Domain\Username` with the user that is used to run the {{% ctx %}} Gateway application pool currently.| |`WebRootFolder` | Replace this with the correct path for the Web Root Folder on the server. Typically this will be `C:\inetpub\wwwroot`.| diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md index 3bfdeda4d..ea026233f 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md @@ -48,7 +48,7 @@ It is possible for {{% ctx %}} Gateway to reuse the certificate used when [insta *>&1 | Tee-Object -FilePath "cortex-gateway-install-log.txt" ``` - {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.EncryptionRequirements" title="Encryption Requirements" >}} steps.{{% /alert %}} + {{% alert title="Important" color="warning" %}}Parameters required to be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}} must be encrypted on one of the servers specified in the {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.EncryptionRequirements" title="Encryption Requirements" >}} steps.{{% /alert %}} | Name | Description | |------------------------------------------------|-------------| diff --git a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server.md b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server.md index 84601d335..5d424eb7e 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server.md +++ b/content/en/docs/2023.11/getting-started/on-premise/install-innovation-only/single-server-without-ha/install-web-application-server.md @@ -197,10 +197,10 @@ Once the certificate has been imported, a `Friendly Name` should be assigned whi |`ServiceFabricApiGatewayEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the server. The port should be specified as `8722` and there must be a trailing slash, e.g. `https://server.domain.com:8722/`.

This will set the `ServiceFabricApiGatewayEndpoint` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricUsingSelfSignedCertificates` | Configure the value as `$false` if you used valid CA certificates when [installing the Application Server][Configure Installation Script], `$true` if you used self-signed certificates.

This will set the `ServiceFabricUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Server][Configure Installation Script]; if so, this value must be configured to the one used.

This will set the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter can be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| - |`ServiceFabricApiGatewayBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Application Server][Configure Installation Script]; if so, this value must be configured to the one used. It can be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This will set the `ServiceFabricApiGatewayBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| + |`ServiceFabricApiGatewayBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Application Server][Configure Installation Script]; if so, this value must be configured to the one used.

This will set the `ServiceFabricApiGatewayBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| |`DotNetFlowDebuggerEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the Web Application Server.

This will set the `DotNetFlowDebuggerEndpoint` value in the {{% ctx %}} Gateway web.config.| |`DotNetFlowDebuggerBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Debugger on the Web Application Server][Install Application Server]; if so, this value must be configured to the one used.

This will set the `DotNetFlowDebuggerBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter can be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| - |`DotNetFlowDebuggerBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Debugger on the Web Application Server][Install Application Server]; if so, this value must be configured to the one used. It can be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This will set the `DotNetFlowDebuggerBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| + |`DotNetFlowDebuggerBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Debugger on the Web Application Server][Install Application Server]; if so, this value must be configured to the one used.

This will set the `DotNetFlowDebuggerBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| |`DotNetFlowDebuggerUsingSelfSignedCertificates` | Configure the value as `$false` if you are using valid CA certificates to secure the communication between {{% ctx %}} Gateway and the Debugger, `$true` if using self-signed certificates.

This will set the `DotNetFlowDebuggerUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`GatewayApplicationPoolUsername` | Replace `Domain\Username` with the user that should be used to run the {{% ctx %}} Gateway application pool as configured in [Get {{% ctx %}} Gateway Application Pool User][Get CORTEX Gateway Application Pool User].| |`WebRootFolder` | Replace this with the correct path for the Web Root Folder on the server. Typically this will be `C:\inetpub\wwwroot`.| From 1536fbbc7fe3de21e795b3a5ce77b8d594a0245b Mon Sep 17 00:00:00 2001 From: Cortex-DMS Date: Thu, 30 Nov 2023 14:49:33 +0000 Subject: [PATCH 21/21] Resolved broken Links following PO Review --- .../configure-debugger-installation-script.md | 3 ++- .../configure-debugger-installation-script.md | 4 ++-- .../perform-gateway-installation.md | 6 +++--- 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md index 8e0f1502d..ed4b7ee21 100644 --- a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md +++ b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md @@ -74,4 +74,5 @@ More advanced configuration (such as changing ports) can be undertaken by modify [Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.CertificateRequirements" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} -[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.EncryptionRequirements" >}}[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} \ No newline at end of file +[Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.EncryptionRequirements" >}} +[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} diff --git a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md index bd83a68e8..92daf10c6 100644 --- a/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md +++ b/content/en/docs/2023.11/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md @@ -64,7 +64,7 @@ |`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. | |`FilePath` | The filename that installation logs are written to. If this should be written to a different location than where the installation files are then a full path should be specified. | - The `ApiGatewayBasicAuthUsername` and `ApiGatewayBasicAuthPassword` will be needed later, [when upgrading Gateway][Install Gateway]. + The `ApiGatewayBasicAuthUsername` and `ApiGatewayBasicAuthPassword` will be needed later, [when upgrading Gateway][Upgrade Gateway]. {{% alert title="Note" %}} More advanced configuration (such as changing ports) can be undertaken by modifying the `Cortex.Innovation.Install.Config.json` file but this shouldn't be required for most installations. More information about this can be found at {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.AdvancedConfigSingleServer" title="Advanced Application Server and Load Balancer Configuration Changes" >}}. @@ -75,4 +75,4 @@ More advanced configuration (such as changing ports) can be undertaken by modify [Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.CertificateRequirements" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.EncryptionRequirements" >}} -[Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} +[Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew" >}} diff --git a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md index da2c88ef2..a01a0b471 100644 --- a/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md +++ b/content/en/docs/2023.11/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation.md @@ -50,10 +50,10 @@ This guide describes how to upgrade {{% ctx %}} Gateway on v7.2 to include Innov |`ServiceFabricApiGatewayEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the Load Balancer Server. The port should be specified if it is not the default HTTPS port (443), and there must be a trailing slash, e.g. `https://server.domain.com/` or `https://server.domain.com:8722/`.

This will set the `ServiceFabricApiGatewayEndpoint` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricUsingSelfSignedCertificates` | Configure the value as `$false` if you used valid CA certificates when [installing the Application Servers][Configure Installation Script], `$true` if you used self-signed certificates.

This will set the `ServiceFabricUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`ServiceFabricApiGatewayBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used.

This will overwrite the `ServiceFabricApiGatewayBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter can be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| - |`ServiceFabricApiGatewayBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used. It can be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This will overwrite the `ServiceFabricApiGatewayBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| + |`ServiceFabricApiGatewayBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Application Servers][Configure Installation Script]; if so, this value must be configured to the one used.

This will overwrite the `ServiceFabricApiGatewayBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| |`DotNetFlowDebuggerEndpoint` | Replace `server.domain.com` with the fully qualified domain name of the Web Application Server.

This will set the `DotNetFlowDebuggerEndpoint` value in the {{% ctx %}} Gateway web.config.| - |`DotNetFlowDebuggerBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Debugger on the Web Application Server][Install Application Server]; if so, this value must be configured to the one used.

This will overwrite the `DotNetFlowDebuggerBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter can be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| - |`DotNetFlowDebuggerBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Debugger on the Web Application Server][Install Application Server]; if so, this value must be configured to the one used. It can be [{{% ctx %}} Encrypted][CORTEX Encrypted].

This will overwrite the `DotNetFlowDebuggerBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| + |`DotNetFlowDebuggerBasicAuthUsername` | This must be changed if you used a non-default `ApiGatewayBasicAuthUsername` when [installing the Debugger on the Web Application Server][Flow Debugger installation]; if so, this value must be configured to the one used.

This will overwrite the `DotNetFlowDebuggerBasicAuthUsername` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter can be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| + |`DotNetFlowDebuggerBasicAuthPassword` | This must be changed if you used a non-default `ApiGatewayBasicAuthPassword` when [installing the Debugger on the Web Application Server][Flow Debugger installation]; if so, this value must be configured to the one used.

This will overwrite the `DotNetFlowDebuggerBasicAuthPassword` value in the {{% ctx %}} Gateway web.config.{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| |`DotNetFlowDebuggerUsingSelfSignedCertificates` | Configure the value as `$false` if you are using valid CA certificates to secure the communication between {{% ctx %}} Gateway and the Debugger, `$true` if using self-signed certificates.

This will set the `DotNetFlowDebuggerUsingSelfSignedCertificates` value in the {{% ctx %}} Gateway web.config.| |`GatewayApplicationPoolUsername` | Replace `Domain\Username` with the user that is used to run the {{% ctx %}} Gateway application pool currently.| |`WebRootFolder` | Replace this with the correct path for the Web Root Folder on the server. Typically this will be `C:\inetpub\wwwroot`.|