Skip to content
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

docs: add tutorial and how-to for installing airgapped Omni #41

Merged
merged 1 commit into from
Jul 5, 2023
Merged
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
---
title: "How to Configure Keycloak for Omni"
draft: false
weight: 220
---

1. Log in to Keycloak.

2. Create a realm.

- In the upper left corner of the page, select the dropdown where it says **master**


{{< imgproc keycloak_001.png Resize "900x" >}}
{{< /imgproc >}}

- Fill in the **realm name** and select **create**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Turns out you can import Omni metadata and simplify the flow.

This button on the clients page.
image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would be fine with adding a note to tell people importing a client could be an option if you have already set it up before and have exported the client configuration, but I don't think the the manual, first-time setup steps should be removed from the tutorial style walk-through.


{{< imgproc keycloak_002.png Resize "900x" >}}
{{< /imgproc >}}

3. Find the realm metadata.

- In the realm settings, there is a link to the metadata needed for SAML under Endpoints.
- Copy the link or save the data to a file. It will be needed for the installation of Omni.

{{< imgproc keycloak_003.png Resize "900x" >}}
{{< /imgproc >}}

4. Create a client

- Select the **Clients** tab on the left

{{< imgproc keycloak_004.png Resize "900x" >}}
{{< /imgproc >}}

- Fill in the **General Settings** as shown in the example below. **Replace the hostname in the example with your own Omni hostname or IP**.
- Client type
- Client ID
- Name

{{< imgproc keycloak_005.png Resize "900x" >}}
{{< /imgproc >}}

- Fill in the **Login settings** as shown in the example below. **Replace the hostname in the example with your own Omni hostname or IP**.
- Root URL
- Valid redirect URIs
- Master SAML PRocessing URL

{{< imgproc keycloak_006.png Resize "900x" >}}
{{< /imgproc >}}

- Modify the **Signature and Encryption** settings.
- Sign documents: **off**
- Sign assertions: **on**

{{< imgproc keycloak_007.png Resize "900x" >}}
{{< /imgproc >}}

- Set the **Client signature required** value to **off**.

{{< imgproc keycloak_008.png Resize "900x" >}}
{{< /imgproc >}}

- Modify **Client Scopes**

{{< imgproc keycloak_009.png Resize "900x" >}}
{{< /imgproc >}}

- Select **Add predefined mapper**.

{{< imgproc keycloak_010.png Resize "900x" >}}
{{< /imgproc >}}

- The following mappers need to be added because they will be used by Omni will use these attributes for assigning permissions.
- X500 email
- X500 givenName
- X500 surname

{{< imgproc keycloak_011.png Resize "900x" >}}
{{< /imgproc >}}

- Add a new user (optional)
- If Keycloak is being used as an Identity Provider, users can be created here.

{{< imgproc keycloak_012.png Resize "900x" >}}
{{< /imgproc >}}

- Enter the **user information** and set the **Email verified** to **Yes**

{{< imgproc keycloak_013.png Resize "900x" >}}
{{< /imgproc >}}

- Set a password for the user.

{{< imgproc keycloak_014.png Resize "900x" >}}
{{< /imgproc >}}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading