-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
website/docs: add credentials prompt for rac doc #14840
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
dewi-tik
merged 13 commits into
main
from
website/docs--add-credentials-prompt-for-rac-doc
Jun 4, 2025
+94
−0
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
d81c199
Adds document
dewi-tik e9944fa
Typo
dewi-tik 93e55fe
Clarified RAC endpoint sentence based on Tana's suggestion.
dewi-tik 1b018f3
Update website/docs/add-secure-apps/providers/rac/rac_credentials_pro…
dewi-tik d2cd829
Small wording improvements
dewi-tik c15e74e
Added connection security type information
dewi-tik d436801
Merge remote-tracking branch 'origin/main' into website/docs--add-cre…
dewi-tik 09c5dd3
A word
dewi-tik ec02f30
Added to sidebar
dewi-tik 4cca1e5
Update website/docs/add-secure-apps/providers/rac/rac_credentials_pro…
dewi-tik 4a17494
Applied suggestions from Tana
dewi-tik 53a6eb2
Update website/docs/add-secure-apps/providers/rac/rac_credentials_pro…
dewi-tik 10cc638
Typo
dewi-tik File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
93 changes: 93 additions & 0 deletions
93
website/docs/add-secure-apps/providers/rac/rac_credentials_prompt.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| --- | ||
| title: RAC Credentials Prompt | ||
| --- | ||
|
|
||
| ## About the RAC credentials prompt | ||
|
|
||
| You can configure the RAC provider to prompt users for their credentials when connecting to RAC endpoints. This is particulalry useful for establishing RDP connections to modern Windows systems that often require credentials to establish a connection. | ||
|
|
||
| After implementing this configuration, when connecting to an RAC endpoint users are prompted to enter their credentials which are then passed to the RAC endpoint. This means that static credentials do not need to be set in the RAC provider, property mapping, or endpoint. | ||
|
|
||
| This configurations requires: | ||
|
|
||
| 1. Creating an authorization flow. | ||
| 2. Creating two prompts. | ||
| 3. Creating and binding a prompt stage. | ||
| 4. Updating the RAC provider. | ||
|
|
||
| ## Create a new authorization flow | ||
|
|
||
| 1. Log in to authentik as an administrator, and open the authentik Admin interface. | ||
| 2. Navigate to **Flows and Stages** > **Flows**, click **Create**, and enter the following required settings: | ||
| - **Name**: Enter a descriptive name for the flow. | ||
| - **Title**: Enter a title for the flow. This will be displayed to users when they're prompted for their credentials. | ||
| - **Slug**: Enter a slug for the flow. This will be displayed in the flow URL. | ||
| - **Designation**: `Authorization` | ||
| - **Authentication**: `Require authentication` | ||
| 3. Click **Create**. | ||
|
|
||
| ## Create prompts | ||
|
|
||
| 1. Log in to authentik as an administrator, and open the authentik Admin interface. | ||
| 2. Navigate to **Flows and Stages** > **Prompts**, click **Create**, and enter the following required settings: | ||
| - **Name**: Enter a descriptive name for the prompt (e.g. `username`). | ||
| - **Field Key**: `connection_settings.username` | ||
| - **Label**: Enter a label for the field which will be displayed above it. | ||
| - **Type**: `Text` | ||
| - **Required**: Toggled on. | ||
| - **Order**: `0` | ||
| 3. Click **Create** to save the prompt. | ||
| 4. On the **Prompts** page, click **Create** again, and enter the following required settings: | ||
| - **Name**: Enter a descriptive name for the prompt (e.g. `password`). | ||
| - **Field Key**: `connection_settings.password` | ||
| - **Label**: Enter a label for the field which will be displayed above it. | ||
| - **Type**: `Password` | ||
| - **Required**: Toggled. | ||
| - **Order**: `1` | ||
| 5. Click **Create** to save the prompt. | ||
|
|
||
| :::note | ||
| You can optionally add other prompt fields such as `domain` (e.g. `connection_settings.domain`), which can be useful for Windows based RDP. There is also the option of adding a `Text (read-only)` type prompt field that includes explanatory text for the user (e.g. `please enter your RDP credentials`). | ||
| ::: | ||
|
|
||
| ## Create and bind a prompt stage | ||
|
|
||
| 1. Log in to authentik as an administrator, and open the authentik Admin interface. | ||
| 2. Navigate to **Flows and Stages** > **Flows**. | ||
| 3. Click the name of the newly created authorization flow. | ||
| 4. Click on **Stage bindings**, click **Create and bind stage**, and enter the following required settings: | ||
| - **Select Type**: Select `Prompt stage` as the prompt type. | ||
| - **Create Prompt Stage**: | ||
| - **Name**: Enter a name for the prompt stage. | ||
| - Under **Fields**: | ||
| - Click the **x** icon to remove all selected fields. | ||
| - Add the two newly created prompt fields (e.g.`username` and `password`) to selected fields. | ||
| - Under **Validation Policies**: | ||
| - Click the **x** icon to remove all selected validation policies. | ||
| - **Create binding**: | ||
| - Click **Finish**. | ||
|
|
||
| ## Update the RAC provider | ||
|
|
||
| 1. Log in to authentik as an administrator, and open the authentik Admin interface. | ||
| 2. Navigate to **Applications** > **Providers**. | ||
| 3. Click the **Edit** icon of the RAC provider that you wish to add a credentials prompt to. | ||
| 4. Change **Authorization flow** to the newly created authorization flow. | ||
| 5. Click **Update** to save the change. | ||
|
|
||
| ## Update the RAC endpoint _(sometimes required)_ | ||
|
|
||
| Depending on the configuration of the RDP server that's being connected to, it is sometimes necessary to set the security type that's used for the connection. For many modern windows RDP servers, this often needs to be set to `tls`. | ||
|
|
||
| 1. Log in to authentik as an administrator, and open the authentik Admin interface. | ||
| 2. Navigate to **Applications** > **Providers** and click the name of the RAC provider that you're using. | ||
| 3. Under **Endpoints**, click the **Edit** icon of the endpoint that you're using. | ||
| 4. Under **Advanced Settings** in the **Settings** box, enter `security: tls` | ||
| 5. Click **Update** to save the change. | ||
|
|
||
| :::note | ||
| Other options for the connection security type are: `any`, `nla`, `nla-ext`, `vmconnect`, and `rdp`. For more information see the [Guacamole RDP Authentication and Security Documentation](https://guacamole.apache.org/doc/gug/configuring-guacamole.html#authentication-and-security). | ||
|
dewi-tik marked this conversation as resolved.
|
||
|
|
||
| ## Configuration verification | ||
|
|
||
| Log in to authentik with a user account that has the required privileges to access the RAC application. Open the User interface, and on the **My applications** page click the RAC application. You should then be redirected to the prompt stage and prompted for a username and password. Enter the credentials for the RAC endpoint and if the credentials are valid, the RDP/SSH/VNC connection should be established. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.