Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions versioned_docs/version-v6.0.0/dashboard/installation/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,32 @@ The following script parameters are used in the deploy script:
| `resourceGroupLocation` | 'West Europe' | Azure location where resources should be deployed |
| `isAdDisabled` | `False` | Boolean flag to indicate whether the Dashboard should use AD for authentication |
| `additionalTemplateParameters` | [] | Additional named parameters for the Bicep template you wish to override. More on this below. |
| `dashboard` | - | **Optional object** to configure custom settings for the Dashboard. Contains the `Gateway` property with custom URL configurations. |

<details>
<summary>**Dashboard object properties**</summary>

The `dashboard` parameter is an optional object that allows you to configure custom settings. If not provided, default values will be used.

**Dashboard.ApplicationGateway** (optional object)
- Configuration object for Application Gateway settings when using a custom gateway setup.

| Property | Type | Required | Description |
| ------------------------------ | -------- | :------: | -------------------------------------------------------------------------------------------- |
| `baseApiRootUrl` | `string` | No | Custom URL for the Dashboard Gateway Function. Use this when you have a custom gateway configuration that differs from the default deployment. |
| `nextAuthUrl` | `string` | No | Custom URL for accessing the Dashboard web application. Use this when you want to specify a custom domain or gateway endpoint for the Dashboard. |

**Example usage in Bicep:**
```bicep
dashboard: {
applicationGateway: {
baseApiRootUrl: 'https://your-custom-domain.com'
nextAuthUrl: 'https://another-custom-domain.com'
}
}
```

</details>

:::info[override [bicep parameters](#bicep-template-parameters)]
The `AdditionalTemplateParameters` can be used to override the default values used by the Bicep template. You simply name the argument as the parameter. For example if you want to use a different `servicePlanSku` you would add `-eventHubSkuName 'Standard'` to the parameters of the `./Deploy.ps1` script.
Expand Down