Skip to content

Commit 2472ae5

Browse files
cortex-lpcortex-lp
committed
after first run
1 parent e2cdad8 commit 2472ae5

File tree

3 files changed

+44
-34
lines changed

3 files changed

+44
-34
lines changed

‎content/en/docs/2025.3/getting-started/on-premise/add-configuration-portal-to-cortex/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ weight: 50
66
---
77

88
{{< alert title="Important" color="warning" >}}
9-
This guide currently only describe how to add the {{% ctx %}} Configuration Portal to an existing Web Application Server. For any other installation scenario, please contact {{< ahref path="Cortex.ServicePortal.MainDoc" title="CORTEX Service Portal" >}}.
9+
This guide currently only describe how to add the {{% ctx %}} Configuration Portal to an existing Web Application Server with {{% ctx %}} Gateway installed. For any other installation scenario, please contact {{< ahref path="Cortex.ServicePortal.MainDoc" title="CORTEX Service Portal" >}}.
1010
{{% /alert %}}

‎content/en/docs/2025.3/getting-started/on-premise/add-configuration-portal-to-cortex/installation/_index.md‎

Lines changed: 39 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -23,24 +23,26 @@ To import the flows, perform the following steps:
2323
1. `Configuration.Portal.Core.Flows.studiopkg`, which can be found in the folder named `Cortex Configuration Portal`.
2424
1. `Interaction.Portal.Core.Flows.studiopkg`, which can be found in the folder named `Cortex Interaction Portal`.
2525
1. `User Access Management.Flows.studiopkg`, which can be found in the folder named `User Access Management`.
26-
1. Once imported, Set up the access to these flows using Studio Authorisation.
26+
1. Once imported, set up the access to these flows using Studio Authorisation.
27+
2728
{{< alert type="note" title="Note" >}}
28-
Once the flows are imported, they should be available from the ‘Dev’ charms menu. Note that you may need to refresh {{% ctx %}} Gateway after importing
29+
Once the flows are imported, they should be available from the ‘Dev’ charms menu. Note that you may need to refresh {{% ctx %}} Gateway after importing.
2930
{{< /alert >}}
3031

3132
### Configure the flows
3233

3334
#### User Access Management flow
3435

3536
1. Within {{% ctx %}} Gateway, open the `Dev` charms then search for `UAM-Get-Config`
37+
1. Open the flow.
3638
1. Click on the first `Set Variable` block to show the properties.
3739
1. Within the value field, update the following parameters only:
3840
| Name | Description | Example |
3941
|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|
4042
| PowerShellDetails.Username | The username of an account that can run PowerShell commands on all {{% ctx %}} servers, e.g., Service Account. {{< alert type="note" title="Note" >}}This user should be an administrator across the {{% ctx %}} servers.{{< /alert >}} | `"ctx_serviceuser"` |
4143
| PowerShellDetails.Password | The password for the username specified for `PowerShellDetails.Username`. {{< alert type="note" title="Note" >}}This field must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | `"#_124211015226168!130105247000243225146179242013178~146135159100034!214216128191025238010012072111212#"` |
4244
| PowerShellDetails.Domain | The domain for the username specified for `PowerShellDetails.Username`. | `"domain.com"` |
43-
| PowerShellDetails.Host | The FQDN of the host executing the PowerShell commands. {{< alert type="note" title="Note" >}}This can be `Environment.MachineName` to use the current node executing the flow.{{< /alert >}} | `"cortexapp-machine.domain.com"` or `Environment.MachineName` |
45+
| PowerShellDetails.Host | The host executing the PowerShell commands. {{< alert type="note" title="Note" >}}This can be `Environment.MachineName` to use the current node executing the flow.{{< /alert >}} | `"cortexapp-machine.domain.com"` or `"cortexapp-machine"` or `Environment.MachineName` |
4446
| PowerShellDetails.Port | The PowerShell port. | `5985` |
4547
| PowerShellDetails.SSL | Whether to use SSL for the PowerShell command. | `false` |
4648
| RecursiveAccessControl | Whether child user groups should inherit access control granted to parents. | `false` |
@@ -82,16 +84,17 @@ This should look similar to the following:
8284
#### Configuration Management flow
8385

8486
1. Within {{% ctx %}} Gateway, open the `Dev` charms then search for `CM-Config-Settings`
87+
1. Open the flow.
8588
1. Click on the first `Set Variable` block to show the properties.
8689
1. Within the value field, update the following parameters only:
8790
| Name | Description | Example |
8891
|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|
8992
| PowerShellDetails.Username | The username of an account that can run PowerShell commands on the host specified for `PowerShellDetails.Host`, e.g., Service Account. {{< alert type="note" title="Note" >}}This user should be an administrator on the targeted Host.{{< /alert >}} | `"ctx_serviceuser"` |
9093
| PowerShellDetails.Password | The password for the username specified for `PowerShellDetails.Username`. {{< alert type="note" title="Note" >}}This field must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | `"#_124211015226168!130105247000243225146179242013178~146135159100034!214216128191025238010012072111212#"` |
9194
| PowerShellDetails.Domain | The domain for the username specified for `PowerShellDetails.Username`. | `"domain.com"` |
92-
| PowerShellDetails.Host | The FQDN of the host executing the PowerShell commands. {{< alert type="note" title="Note" >}}This must target a specific {{% ctx %}} Server.{{< /alert >}} | `"cortexapp-machine.domain.com"` |
95+
| PowerShellDetails.Host | The host executing the PowerShell commands. {{< alert type="note" title="Note" >}}This must target a specific {{% ctx %}} Server.{{< /alert >}} | `"cortexapp-machine.domain.com"` or `"cortexapp-machine"` |
9396
| PowerShellDetails.Port | The PowerShell port. | `5985` |
94-
| CortexInteractionPortalPath | The path to the Cortex Interaction Portal. | `@"C:\inetpub\wwwroot\Cortex\ConfigurationPortal"` |
97+
| CortexInteractionPortalPath | The path to the Cortex Configuration Portal. | `@"C:\inetpub\wwwroot\Cortex\ConfigurationPortal"` |
9598
| ConfigurationExportsFolder | The folder containing the configuration being exported. | `@"ConfigurationModule\Exports"` |
9699
| ConfigurationImportsFolder | The folder containing the configuration being imported. | `@"ConfigurationModule\Imports"` |
97100
| ConfigurationBackupsFolder | The folder containing the configuration backups if scheduled. | `@"ConfigurationModule\Backups"` | | `false` |
@@ -149,6 +152,8 @@ This should look similar to the following:
149152
1. Once published:
150153
1. Select the `Authorisation` tab
151154
1. Select the groups that should be able to execute this package
155+
1. Click `Save`
156+
152157
{{< alert type="note" title="Note" >}}
153158
Keep a note of the selected groups, as they will be required when setting the access control for the {{% ctx %}} Configuration Portal.
154159
{{< /alert >}}
@@ -161,12 +166,12 @@ On the Web Application Server:
161166

162167
1. Open the folder where the `Cortex Innovation {{< version >}} - Configuration Portal.zip` was extracted.
163168
1. From there, open the `Cortex Configuration Portal` folder.
164-
1. Open the `Cortex.Configuration.Portal.zip` file and extract the contents to where the website is to be installed.
169+
1. Extract the contents of the `Cortex.Configuration.Portal.zip` file to where the website is to be installed.
165170
{{< alert type="note" title="Note" >}}
166171
Typically this is `C:\inetpub\wwwroot\Cortex\ConfigurationPortal`
167172
{{< /alert >}}
168-
1. Copy the `web.config` and `appsettings.json` files from the `Cortex Configuration Portal` folder to the root of the extracted website folder.
169-
1. Once copied, open the `appsettings.json` file then update the following parameters only:
173+
1. Copy the `web.config` and `config.json` files from the `Cortex Configuration Portal` folder to the root of the extracted website folder.
174+
1. Once copied, open the `config.json` file then update the following parameters only:
170175
| Name | Description | Example |
171176
|--------------------------------|---------------------------------------------------------------------------------------------------|---------------------------------------------|
172177
| ApplicationName | The name of the application, this will be used for containerisation of user sessions. | `"CortexConfigurationDev"` |
@@ -254,7 +259,7 @@ These steps will need to be repeated on all Application Servers.
254259

255260
On the Application Server:
256261

257-
1. Navigate to `C:\ProgramData\SF\<Customer>.<node>\Fabric\work\ImageCache\Store\Cortex.Innovation.Core\ApiGatewayPkg.Code.<version>`
262+
1. Navigate to `C:\ProgramData\SF\<Customer>.<node>\Fabric\work\Applications\Cortex.Innovation.Core_App0\ApiGatewayPkg.Code.<version>`
258263
{{< alert type="note" title="Note" >}}
259264
`<Customer>` and `<node>` will depend on how the node was configured during the installation of {{% ctx %}}.
260265
{{< /alert >}}
@@ -267,30 +272,31 @@ On the Application Server:
267272
| AllowCredentials | Whether to allow credentials, this MUST be set to `true`. | `true` |
268273
| AllowWildCardSubDomains | Whether to allow wildcard subdomains, this MUST be set to `true`. | `true` |
269274

270-
The CORS section should look similar to the following:
271-
272-
``` json
273-
"Cors": {
274-
"Enabled": true,
275-
"AllowedOrigins": [
276-
"https://*.ad.cortex.uk",
277-
"https://*.appgyver.com"
278-
],
279-
"AllowedRequestHeaders": [
280-
"*"
281-
],
282-
"AllowedResponseHeaders": [
283-
],
284-
"AllowedMethods": [
285-
"*"
286-
],
287-
"AllowCredentials": true,
288-
"AllowWildcardSubdomains": true,
289-
"PreflightMaxAgeInMs": 5000
290-
},
291-
```
275+
The CORS section should look similar to the following:
276+
277+
``` json
278+
"Cors": {
279+
"Enabled": true,
280+
"AllowedOrigins": [
281+
"https://*.domain.com",
282+
"https://*.appgyver.com"
283+
],
284+
"AllowedRequestHeaders": [
285+
"*"
286+
],
287+
"AllowedResponseHeaders": [
288+
],
289+
"AllowedMethods": [
290+
"*"
291+
],
292+
"AllowCredentials": true,
293+
"AllowWildcardSubdomains": true,
294+
"PreflightMaxAgeInMs": 5000
295+
},
296+
```
292297

293298
1. Save the file.
299+
1. Repeat these steps for the appsettings.json file located in `C:\ProgramData\SF\<Customer>.<node>\Fabric\work\ImageCache\Store\Cortex.Innovation.Core\ApiGatewayPkg.Code.<version>`.
294300

295301
#### Restart the code package
296302

@@ -301,7 +307,7 @@ These steps will need to be repeated on all Application Servers.
301307
On the Application Server:
302308

303309
1. Navigate to the Service Fabric Explorer, typically `http://localhost:9080/Explorer`.
304-
1. Restart the `ApiGatewayPkg`:
310+
1. Restart the `ApiGatewayPkg` by following these steps:
305311
1. Expand the `Nodes`
306312
1. Select the current node
307313
1. Expand `fabric:/Core/Services`
@@ -323,7 +329,7 @@ On the Web Application Server:
323329
1. In the script section, copy the following script:
324330

325331
``` powershell
326-
\Deploy.Cortex.Configuration.Portal.ps1 `
332+
.\Deploy.Cortex.Configuration.Portal.ps1 `
327333
-URL "https://cortexapp-machine.domain.com" `
328334
-Port "8722" `
329335
-Username "BasicAuthUser" `

‎content/en/docs/2025.3/getting-started/on-premise/add-configuration-portal-to-cortex/requirements.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ weight: 10
99

1010
The requirements for a server installation of the {{% ctx %}} Configuration Portal are laid out in this guide. These must be considered before undertaking installation.
1111

12+
{{< alert color="warning" title="Important" >}}
13+
The Configuration Portal must be installed on the Web Application Server where {{% ctx %}} Gateway is installed.For any other installation scenario, please contact {{< ahref path="Cortex.ServicePortal.MainDoc" title="CORTEX Service Portal" >}}.
14+
{{< /alert >}}
15+
1216
## Domain Requirements
1317

1418
The server must be on a domain and cannot be a domain controller.

0 commit comments

Comments
 (0)