Skip to content

Commit 490afb1

Browse files
cortex-lpcortex-lp
committed
initial doc structure
1 parent 70a0f43 commit 490afb1

File tree

7 files changed

+447
-0
lines changed

7 files changed

+447
-0
lines changed

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Add Configuration Portal to CORTEX"
3+
linkTitle: "Add Configuration Portal to CORTEX"
4+
description: "Information about pre-installation steps and installation instructions for the {{% ctx %}} Configuration Portal for {{% ctx %}}."
5+
weight: 50
6+
---
7+
8+
{{< 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" >}}.
10+
{{% /alert %}}

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

Lines changed: 317 additions & 0 deletions
Large diffs are not rendered by default.

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Post-Installation"
3+
linkTitle: "Post-Installation"
4+
description: "Information about the steps required to be completed after the installation has finished."
5+
weight: 50
6+
---
7+
8+
This guide describes how to perform the steps to verify the installation of {{% ctx %}} and perform final configuration. Please ensure that the [Installation][] has been completed before starting this section.
9+
10+
[Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.Installation" >}}

‎content/en/docs/2025.3/getting-started/on-premise/add-configuration-portal-to-cortex/post-installation/try-it-out.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Try it out"
3+
linkTitle: "Try it out"
4+
description: "Information about trying out {{% ctx %}} for the first time."
5+
weight: 10
6+
---
7+
8+
# {{% param title %}}
9+
10+
This guide describes how to try out a new {{% ctx %}} installation to make sure it is working. Please ensure that [Setup Gateway][] has been completed before taking these steps.
11+
12+
## Test Debugging Flows
13+
14+
15+
## Test Publishing Production Flows
16+
17+
18+
## Test Executing Production Flows
19+

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

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: "Pre-Installation"
3+
linkTitle: "Pre-Installation"
4+
description: "Information about the steps required to be completed prior to starting the installation."
5+
weight: 20
6+
---
7+
8+
# {{% param title %}}
9+
10+
This guide describes how to perform the steps required before starting the installation of the {{% ctx %}} Configuration Portal.
11+
12+
## Make Installation Artefacts Available
13+
14+
1. Copy the following artefacts to a folder on the Web Application Server:
15+
* Cortex Innovation {{< version >}} - Configuration Portal.zip
16+
17+
{{< alert title="Important" color="warning" >}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in this folder or a subfolder.{{% /alert %}}
18+
19+
1. Extract the `Cortex Innovation {{< version >}} - Configuration Portal.zip` file to a folder with the same name.
20+
21+
## Next Steps?
22+
23+
1. [Installation][]
24+
25+
[Installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddConfigurationPortalToCortex.Installation.MainDoc" >}}

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

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
title: "Requirements"
3+
linkTitle: "Requirements"
4+
description: "Information about the requirements required."
5+
weight: 10
6+
---
7+
8+
# {{% param title %}}
9+
10+
The requirements for a server installation of the {{% ctx %}} Configuration Portal are laid out in this guide. These must be considered before undertaking installation.
11+
12+
## Domain Requirements
13+
14+
The server must be on a domain and cannot be a domain controller.
15+
16+
## Active Directory Requirements
17+
18+
For Gateway, only Windows domains with an Active Directory domain controller running Active Directory Domain Services are supported.
19+
20+
Supported versions of Active Directory are listed below:
21+
22+
| Version | Verified? | Supported From | Supported Until |
23+
|------------------------|-----------|---------------------|-----------------|
24+
| Windows Server 2016 | | {{% ctx %}} v2025.3 | To be evaluated |
25+
| Windows Server 2019 | ✓ | {{% ctx %}} v2025.3 | To be evaluated |
26+
| Windows Server 2022 | | {{% ctx %}} v2025.3 | To be evaluated |
27+
28+
## DNS Requirements
29+
30+
The installation requires IP to hostname resolution to be available. Please ensure that you have the appropriate pointer (PTR) records configured on the DNS server for the server.
31+
32+
## Web Browser Requirements
33+
34+
Gateway supports the latest versions of the following browsers:
35+
36+
* Chrome
37+
* Edge
38+
* Firefox
39+
40+
## Security Requirements
41+
42+
### Installation User
43+
44+
A domain user with the necessary administrative permissions to log on to the Configuration Portal host server via Remote Desktop and execute PowerShell scripts.
45+
46+
### PowerShell User
47+
48+
A service user with the necessary permissions to execute PowerShell scripts on the Configuration Portal host server, and has right to query Active Directory.
49+
50+
### IIS Application Pool User
51+
52+
For the Configuration Portal, a domain user must be available to run the IIS Application Pool. This user must be given `Log on as a service` and `Log on as a batch job` permissions otherwise the Application Pool will not be able to run. Information about how to do this will be given during installation.
53+
54+
### Domain Groups
55+
56+
The Active Directory groups to which access to the Configuration Portal should be granted must be known prior to installation.
57+
58+
## Next Steps?
59+
60+
1. [Pre-Installation][]
61+
62+
[Pre-Installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddConfigurationPortalToCortex.PreInstallation" >}}

‎data/urls.toml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -539,6 +539,10 @@
539539
ConfigureAlloy = "/docs/getting-started/on-premise/add-observability-to-innovation/grafana/install-alloy/configure-alloy"
540540
[Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallAlloy.InstallAlloy]
541541
MainDoc = "/docs/getting-started/on-premise/add-observability-to-innovation/grafana/install-alloy/install-alloy"
542+
[Cortex.GettingStarted.OnPremise.AddConfigurationPortalToCortex]
543+
PreInstallation = "/docs/getting-started/on-premise/add-configuration-portal-to-cortex/pre-installation"
544+
[Cortex.GettingStarted.OnPremise.AddConfigurationPortalToCortex.Installation]
545+
MainDoc = "/docs/getting-started/on-premise/add-configuration-portal-to-cortex/installation"
542546
[Cortex.GettingStarted.Cloud]
543547
MainDoc = "/docs/getting-started/cloud"
544548
[Cortex.GettingStarted.Cloud.AddObservabilityToInnovation]

0 commit comments

Comments
 (0)