Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
10 changes: 8 additions & 2 deletions config/_default/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -203,16 +203,22 @@ enable = true
[[menu.main]]
identifier = 'documentation'
name = 'Documentation'
url = '/docs/2025.9'
url = '/docs/2026.3'
weight = 10

# Releases menu
[[params.versions]]
version = "2026.3"
url = "/docs/2026.3/"
dotNetVersion = "net-8.0"
inSupport = true
latest = true

[[params.versions]]
version = "2025.9"
url = "/docs/2025.9/"
dotNetVersion = "net-8.0"
inSupport = true
latest = true

[[params.versions]]
version = "2025.7"
Expand Down
6 changes: 6 additions & 0 deletions content/en/docs/2026.3/FAQs/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "FAQs"
linkTitle: "FAQs"
description: "Answers to our most frequently asked questions."
weight: 10000
---
6 changes: 6 additions & 0 deletions content/en/docs/2026.3/FAQs/check-cluster-health/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "How do I check cluster health?"
linkTitle: "How do I check cluster health?"
description: "Instructions on how to check the health of your cluster."
weight: 100
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "Multiple Server with HA"
linkTitle: "Multiple Server with HA"
description: "Instructions on how to check the health of your multiple server cluster."
weight: 1
---

# Check Cluster Health

## Import Client Certificate

In order to access the [Service Fabric Explorer][] to check the health of the cluster, it is necessary for the client certificate specified during the [installation of {{% ctx %}}][Configure Installation Script] to be imported in to the current user store on the machine it is being accessed from.

Instructions on how to do this can be found [here][Import Client Certificate].

## View Cluster Health

1. Open a web browser.
1. {{< section "/install-application-server/multi-server/check-application-services.md">}}

[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" >}}
[Import Client Certificate]: {{< url path="Cortex.Faqs.ImportClientCertificate.MultiServer" >}}
[Service Fabric Explorer]: {{< url path="Cortex.Reference.Glossary.P-T.ServiceFabricExplorer" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "Single Server without HA"
linkTitle: "Single Server without HA"
description: "Instructions on how to check the health of your single server cluster."
weight: 2
---

# Check Cluster Health

## Import Client Certificate

In order to access the [Service Fabric Explorer][] to check the health of the cluster, it is necessary for the client certificate specified during the [installation of {{% ctx %}}][Configure Installation Script] to be imported in to the current user store on the machine it is being accessed from.

Instructions on how to do this can be found [here][Import Client Certificate].

## View Cluster Health

1. Open a web browser.
1. {{< section "/install-application-server/single-server/check-application-services.md">}}

[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScriptNew" >}}
[Import Client Certificate]: {{< url path="Cortex.Faqs.ImportClientCertificate.SingleServer" >}}
[Service Fabric Explorer]: {{< url path="Cortex.Reference.Glossary.P-T.ServiceFabricExplorer" >}}
8 changes: 8 additions & 0 deletions content/en/docs/2026.3/FAQs/configure-code-analyser/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "How do I configure the code analyser?"
linkTitle: "How do I configure the code analyser?"
description: "Instructions on how to configure the code analyser to allow flows to be run."
weight: 200
---

{{< section "/configure-code-analyser/configure-code-analyser.md" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Multiple Server With HA"
linkTitle: "Multiple Server With HA"
description: "Instructions on how to configure the code analyser on a multiple server cluster."
weight: 10
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "How do I disable the code analyser on a multiple server cluster?"
linkTitle: "How do I disable the code analyser on a multiple server cluster?"
description: "Instructions on how to disable the code analyser on a multiple server cluster."
weight: 20
---

# Disable Code Analyser

On each Application Server and the Web Application Server:

{{< section "/configure-code-analyser/multi-server/disable-code-analyser.md" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "How do I update the code analyser allowed list on a multiple server cluster?"
linkTitle: "How do I update the code analyser allowed list on a multiple server cluster?"
description: "Instructions on how to update the code analyser allowed list on a multiple server cluster."
weight: 10
---

# Update Code Analyser Allowed List

{{< section "/configure-code-analyser/update-code-analyser.md" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Single Server Without HA"
linkTitle: "Single Server Without HA"
description: "Instructions on how to configure the code analyser on a single server cluster."
weight: 20
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "How do I disable the code analyser on a single server cluster?"
linkTitle: "How do I disable the code analyser on a single server cluster?"
description: "Instructions on how to disable the code analyser on a single server cluster."
weight: 20
---

# Disable Code Analyser

On the Application Server:

{{< section "/configure-code-analyser/single-server/disable-code-analyser.md" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "How do I update the code analyser allowed list on a single server cluster?"
linkTitle: "How do I update the code analyser allowed list on a single server cluster?"
description: "Instructions on how to update the code analyser allowed list on a single server cluster."
weight: 10
---

# Update Code Analyser Allowed List

{{< section "/configure-code-analyser/update-code-analyser.md" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "How do I configure OpenID Connect authentication?"
linkTitle: "How do I configure OpenID Connect authentication?"
description: "Instructions on how to configure OpenID Connect authentication for {{% ctx %}} Gateway."
weight: 300
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
title: "Microsoft Entra"
linkTitle: "Microsoft Entra"
description: "Instructions on how to configure Microsoft Entra OIDC Authentication for use in {{% ctx %}} Gateway."
weight: 1
---

# {{% param title %}}

## Configure Microsoft Entra OIDC Provider

{{% alert title="Note" %}}
In order to configure a Microsoft Entra Provider a Microsoft Azure account with at least the `Application Developer` role is needed. A `Workforce` or `External Tenant` is also required.
{{% /alert %}}

1. Register {{% ctx %}} Gateway as an application to create a trust relationship between {{% ctx %}} Gateway and the Microsoft Identity Platform:
1. Login to Microsoft Azure and navigate to `Microsoft Entra ID` > `Manage` > `App registrations`.
1. Select `+ New registration`.
1. Enter a meaningful Name for the {{% ctx %}} Gateway application.
1. Select the appropriate Supported account type, e.g. `Accounts in this organizational directory only`.
1. Click `Register`.
1. Add a Redirect URI to allow {{% ctx %}} Gateway to send log in and log out requests to the Entra endpoint:
1. Select the application registration created in Step 1.
1. Click `Redirect URIs`.
1. Click `+ Add a platform`.
1. Select Single-page application and set:
* `Redirect URIs` to `<protocol>://<host>:<port>/<webapplicationname>/redirect`, e.g. `https://server.domain.com/gateway/redirect`.
* `Front-channel logout URL` to `https://localhost:44321/signout-callback-oidc`.
* `Implicit grant and hybrid flows` to `ID tokens`.
1. Click `Configure`.
1. Configure permissions for {{% ctx %}} Gateway to access the user's data using Microsoft Graph:
1. Select the application registration created in Step 1.
1. Select `API permissions` from the menu on the left.
{{% alert title="Note" %}}The Delegated permission `User.Read` was added automatically when the application was registered.{{% /alert %}}
1. Click `+ Add a permission`
* Select `Microsoft Graph`
* Select `Application permissions`.
* Locate and expand `GroupMember` and select `GroupMember.Read.All` to allow the application to authenticate itself without user interaction or consent.
* Click `Add permissions`.
1. Click `+ Add a permission` again.
* Select `Microsoft Graph`
* Select `Delegated permissions`
* Locate and expand `Openid permissions`, and select:
* `email` to allow access to view the users’ email address.
* `offline_access` to maintain access to data already accessed.
* `openid` to allow users to sign in.
* `profile` to allow access to view the user’s basic profile.
* Click `Add permissions`.
1. Configure the application registration to return the Entra groups to {{% ctx %}} Gateway:
1. Select the application registration created in Step 1.
1. Select `Token configuration` from the menu on the left.
1. Click `+ Add groups claim`.
1. Select `Security groups`.
1. Locate and expand `ID`.
* Select `sAMAccountName`.
1. Click `Add`.
1. Create credentials for {{% ctx %}} Gateway to authenticate with Entra securely:
1. Select the application registration created in Step 1.
1. Select `Client credentials`.
1. Click `+ New client secret`.
1. Enter a `Description` for the client secret.
1. In the `Expires` dropdown, select an expiration for the secret or specify a custom lifetime.
1. Select `Add`.
{{% alert title="Warning" color="warning" %}}Make a note of the client secret Value as this is never displayed again after you have left this page.{{% /alert %}}

## Configure {{% ctx %}} Gateway to use Microsoft Entra Authentication

{{% alert title="Note" %}}
In order to configure {{% ctx %}} Gateway to use a Microsoft Entra OpenID Connect Provider, an application MUST be registered and configured as specified in {{< ahref path="Cortex.Faqs.ConfigureOidcAuthentication.MicrosoftEntra.Entra" title="Configure Microsoft Entra OIDC Provider" >}}
{{% /alert %}}

1. Log on to {{% ctx %}} Gateway using the local Administrator account or as a user with the `Admin` role.
1. Select `Admin` > `Authentication`.
1. Select the `OpenID Connect` tab.
1. Click `+ New Provider` and enter the provider details:
1. `Identifier` - a unique free-format identifier for this provider. This cannot be edited once the form has been saved.
1. `Display Name` - free-format text to be displayed on the provider tab and login button.
1. `Authority` - the URL to access the provider authentication. For Microsoft Entra authentication this should be `https://login.microsoftonline.com`.
1. `Tenant Identifier` - the Tenant ID. This can be obtained from the Application registration details in Microsoft Entra by clicking on the registration to display its details. Copy the value for `Directory (tenant) ID`.
1. `Client Identifier` - the Client ID. This can be obtained from the Application registration details in Microsoft Entra by clicking on the registration to display its details. Copy the value for `Application (client) ID`.
1. `Client Secret` - the client secret that was revealed when creating the client credentials for the Application in Microsoft Entra. If you do not have access to the client secret, it will be necessary to create a new client secret in Microsoft Entra - for guidance see step 5 in [Configure Microsoft Entra OIDC][].
1. Click `Validate` to validate the information entered and enable the Save button.
{{% alert title="Note" %}}Validate does not validate the accuracy of the information entered, it only validates that it is of the correct format.{{% /alert %}}
1. Click `Save` to save the provider’s configuration.

{{% alert title="Note" %}}It may be necessary to refresh the browser to ensure correct operation.{{% /alert %}}

[Configure Microsoft Entra OIDC]: {{< url path="Cortex.Faqs.ConfigureOidcAuthentication.MicrosoftEntra.Entra" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "How do I import the client certificate used to check cluster health?"
linkTitle: "How do I import the client certificate used to check cluster health?"
description: "Instructions on how to import the client certificate used to check the cluster health."
weight: 100
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "Multiple Server with HA"
linkTitle: "Multiple Server with HA"
description: "Instructions on how to import the client certificate used to check your multiple server cluster health."
weight: 1
---

# Import Client Certificate

## Using CA Certificates

In order to check the cluster health in Service Fabric Explorer and RabbitMQ, the certificate specified for `ClientCertificatePath` during [installation of the Application Servers][Configure Application Server Installation Script], or `ServerCertificatePath` during [installation of the Flow Debugger][Configure Flow Debugger Installation Script] will need to be imported to the local certificate store on the machine that is being used to browse from:

{{< section "/faqs/import-ca-client-certificate.md">}}

## Using Self Signed Certificates

In order to check the cluster health in Service Fabric Explorer and RabbitMQ, the certificate generated when specifying `UseSelfSignedCertificates` during [installation of the Application Servers][Configure Application Server Installation Script], or during [installation of the Flow Debugger][Configure Flow Debugger Installation Script] will need to be imported to the local certificate store on the machine that is being used to browse from:

{{< section "/faqs/import-selfsigned-client-certificate.md">}}

[Configure Application Server Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" >}}
[Configure Flow Debugger Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureDebuggerInstallationScript" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: "Single Server without HA"
linkTitle: "Single Server without HA"
description: "Instructions on how to import the client certificate used to check your single server cluster health."
weight: 1
---

# Import Client Certificate

## Using CA Certificates

In order to check the cluster health in Service Fabric Explorer and RabbitMQ, the certificate specified for `ServerCertificatePath` during [installation of the Application Servers][Configure Application Server Installation Script] will need to be imported to the local certificate store on the machine that is being used to browse from:

{{< section "/faqs/import-ca-client-certificate.md">}}

## Using Self Signed Certificates

In order to check the cluster health in Service Fabric Explorer and RabbitMQ, the certificate generated when specifying `UseSelfSignedCertificates` during [installation of the Application Servers][Configure Application Server Installation Script] will need to be imported to the local certificate store on the machine that is being used to browse from:

{{< section "/faqs/import-selfsigned-client-certificate.md">}}

[Configure Application Server Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScriptNew" >}}
6 changes: 6 additions & 0 deletions content/en/docs/2026.3/Guides/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Guides"
linkTitle: "Guides"
description: "This section includes all guides for the {{% ctx %}} platform."
weight: 10
---
9 changes: 9 additions & 0 deletions content/en/docs/2026.3/Guides/cortex-gateway/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "CORTEX Gateway"
linkTitle: "CORTEX Gateway"
description: "The centralised web-based portal for accessing all user applications and tooling in the {{% ctx %}} platform."
weight: 50
outOfSupport: true
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "CORTEX Gateway Management"
linkTitle: "CORTEX Gateway Management"
description: "{{% ctx %}} Gateway and Studio Management tools and settings"
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "LDAP Authorisation"
linkTitle: "LDAP Authorisation"
description: "Configure RBAC by assining roles to security groups."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "LDAP Connection"
linkTitle: "LDAP Connection"
description: "Connect to an Active Directory using LDAP."
---

{{< workinprogress >}}
7 changes: 7 additions & 0 deletions content/en/docs/2026.3/Guides/cortex-innovation/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "CORTEX Applications"
linkTitle: "CORTEX Applications"
description: "The Service Fabric applications hosting the services within the {{% ctx %}} platform."
weight: 300
outOfSupport: true
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Core Application"
linkTitle: "Core Application"
description: "The Core Application."
weight: 1
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Services"
linkTitle: "Services"
description: "The Core Application Services."
weight: 1
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "API Gateway Service"
linkTitle: "API Gateway Service"
description: "The API Gateway Service."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Authorisation Service"
linkTitle: "Authorisation Service"
description: "The Authorisation Service."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Concurrency Management Service"
linkTitle: "Concurrency Management Service"
description: "The Concurrency Management Service."
---

{{< workinprogress >}}
Loading
Loading