website/integrations: add Gravitee integration (#4564)
* Add documentation on using Authentik with Gravitee Adds documentation on using Authentik with Gravitee Signed-off-by: barrelltitor <108460132+barrelltitor@users.noreply.github.com> * Update sidebarsIntegrations.js Signed-off-by: barrelltitor <108460132+barrelltitor@users.noreply.github.com> * format Signed-off-by: Jens Langhammer <jens@goauthentik.io> --------- Signed-off-by: barrelltitor <108460132+barrelltitor@users.noreply.github.com> Signed-off-by: Jens Langhammer <jens@goauthentik.io> Co-authored-by: Jens Langhammer <jens@goauthentik.io>
This commit is contained in:
barrelltitor
GitHub
parent
b85b5d8c3b
commit
ecd5fab082
|
|
@ -0,0 +1,62 @@
|
||||||
|
---
|
||||||
|
title: Gravitee
|
||||||
|
---
|
||||||
|
|
||||||
|
<span class="badge badge--secondary">Support level: Community</span>
|
||||||
|
|
||||||
|
## What is Gravitee
|
||||||
|
|
||||||
|
From https://github.com/gravitee-io/gravitee-api-management
|
||||||
|
|
||||||
|
:::note
|
||||||
|
Gravitee.io API Management is a flexible, lightweight and blazing-fast Open Source solution that helps your organization control who, when and how users access your APIs.
|
||||||
|
:::
|
||||||
|
|
||||||
|
It offers an easy to use GUI to setup proxies for APIs, rate limiting, api keys, caching, OAUTH rules, a portal that can be opened to the public for people to subscribe to APIs, and much more.
|
||||||
|
|
||||||
|
## Preparation
|
||||||
|
|
||||||
|
The following placeholders will be used:
|
||||||
|
|
||||||
|
- `gravitee.company` is the FQDN of the Gravitee install.
|
||||||
|
- `authentik.company` is the FQDN of the authentik install.
|
||||||
|
- `applicationName` is the Application name you set.
|
||||||
|
|
||||||
|
### Step 1 - authentik
|
||||||
|
|
||||||
|
In authentik, under _Providers_, create an _OAuth2/OpenID Provider_ with these settings:
|
||||||
|
|
||||||
|
:::note
|
||||||
|
Only settings that have been modified from default have been listed.
|
||||||
|
:::
|
||||||
|
|
||||||
|
**Protocol Settings**
|
||||||
|
|
||||||
|
- Name: applicationName
|
||||||
|
- Client ID: Copy and Save this for Later
|
||||||
|
- Client Secret: Copy and Save this for later
|
||||||
|
- Redirect URIs/Origins:
|
||||||
|
|
||||||
|
```
|
||||||
|
https://gravitee.company/user/login
|
||||||
|
https://gravitee.company/console/ # Make sure to add the trailing / at the end, at the time of writing it does not work without it
|
||||||
|
```
|
||||||
|
|
||||||
|
Now, under _Applications_, create an application with the name `applicationName` and select the provider you've created above.
|
||||||
|
|
||||||
|
### Step 2 - Gravitee
|
||||||
|
|
||||||
|
In the Gravitee Management Console, head to _Organizations_(gravitee.company/console/#!/organization/settings/identities) , under _Console_, _Authentication_, click _Add an identity provider_, select _OpenID Connect_, and fill in the following:
|
||||||
|
|
||||||
|
:::note
|
||||||
|
Only settings that have been modified from default have been listed.
|
||||||
|
:::
|
||||||
|
|
||||||
|
- Allow portal authentication to use this identity provider: enable this
|
||||||
|
- Client ID: Client ID from step 1
|
||||||
|
- Client Secret: Client Secret from step 1
|
||||||
|
- Token Endpoint: `https://authentik.company/application/o/token/`
|
||||||
|
- Authorize Endpoint: `https://authentik.company/application/o/authorize/`
|
||||||
|
- Userinfo Endpoint: `https://authentik.company/application/o/userinfo/`
|
||||||
|
- Userinfo Logout Endpoint: `https://authentik.company/if/session-end/applicationName/`
|
||||||
|
- Scopes: `email openid profile`
|
||||||
|
|
@ -62,27 +62,28 @@ module.exports = {
|
||||||
"services/harbor/index",
|
"services/harbor/index",
|
||||||
"services/hashicorp-vault/index",
|
"services/hashicorp-vault/index",
|
||||||
"services/minio/index",
|
"services/minio/index",
|
||||||
"services/qnap-nas/index",
|
|
||||||
"services/opnsense/index",
|
"services/opnsense/index",
|
||||||
"services/pfsense/index",
|
"services/pfsense/index",
|
||||||
"services/pgadmin/index",
|
"services/pgadmin/index",
|
||||||
"services/powerdns-admin/index",
|
"services/powerdns-admin/index",
|
||||||
"services/snipe-it/index",
|
"services/qnap-nas/index",
|
||||||
"services/truecommand/index",
|
|
||||||
"services/sssd/index",
|
|
||||||
"services/veeam-enterprise-manager/index",
|
|
||||||
"services/skyhigh/index",
|
"services/skyhigh/index",
|
||||||
|
"services/snipe-it/index",
|
||||||
|
"services/sssd/index",
|
||||||
|
"services/truecommand/index",
|
||||||
|
"services/veeam-enterprise-manager/index",
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
type: "category",
|
type: "category",
|
||||||
label: "Miscellaneous",
|
label: "Miscellaneous",
|
||||||
items: [
|
items: [
|
||||||
|
"services/gravitee/index",
|
||||||
"services/home-assistant/index",
|
"services/home-assistant/index",
|
||||||
|
"services/jellyfin/index",
|
||||||
"services/node-red/index",
|
"services/node-red/index",
|
||||||
"services/sonarr/index",
|
"services/sonarr/index",
|
||||||
"services/tautulli/index",
|
"services/tautulli/index",
|
||||||
"services/jellyfin/index",
|
|
||||||
"services/weblate/index",
|
"services/weblate/index",
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
|
|
||||||
Reference in New Issue