website/integrations: gravity: add (#13258)
* wip * Update index.md Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com> Signed-off-by: Dominic R <dominic@sdko.org> * wip Signed-off-by: Dominic R <dominic@sdko.org> --------- Signed-off-by: Dominic R <dominic@sdko.org> Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
This commit is contained in:
61
website/integrations/services/gravity/index.md
Normal file
61
website/integrations/services/gravity/index.md
Normal file
@ -0,0 +1,61 @@
|
||||
---
|
||||
title: Integrate with Gravity
|
||||
sidebar_label: Gravity
|
||||
support_level: community
|
||||
---
|
||||
|
||||
## What is Gravity
|
||||
|
||||
> Gravity is a fully-replicated DNS, DHCP, and TFTP server powered by [etcd](https://etcd.io/), offering features like built-in caching, ad/privacy blocking, automatic DNS registration, and metric tracking.
|
||||
>
|
||||
> -- https://gravity.beryju.io/
|
||||
|
||||
## Preparation
|
||||
|
||||
The following placeholders are used in this guide:
|
||||
|
||||
- `gravity.company` is the FQDN of the Gravity installation.
|
||||
- `authentik.company` is the FQDN of the authentik installation.
|
||||
|
||||
:::note
|
||||
This documentation lists only the settings that you need to change from their default values. Be aware that any changes other than those explicitly mentioned in this guide could cause issues accessing your application.
|
||||
:::
|
||||
|
||||
:::note
|
||||
Gravity automatically triggers SSO authentication when configured. To prevent this behavior, log in using the following URL: <kbd>https://<em>gravity.company</em>/ui/?local</kbd>.
|
||||
:::
|
||||
|
||||
## authentik configuration
|
||||
|
||||
To support the integration of Gravity with authentik, you need to create an application/provider pair in authentik.
|
||||
|
||||
### Create an application and provider in authentik
|
||||
|
||||
1. Log in to authentik as an admin, and open the authentik Admin interface.
|
||||
2. Navigate to **Applications** > **Applications** and click **Create with Provider** to create an application and provider pair. (Alternatively, you can create only an application, without a provider, by clicking **Create**.)
|
||||
|
||||
- **Application**: Provide a descriptive name, an optional group for the type of application, the policy engine mode, and optional UI settings.
|
||||
- **Choose a Provider type**: Select **OAuth2/OpenID Connect** as the provider type.
|
||||
- **Configure the Provider**: Provide a name (or accept the auto-provided name), choose the authorization flow for this provider, and configure the following required settings:
|
||||
- Note the **Client ID**, **Client Secret**, and **slug** values because they will be required later.
|
||||
- Set a `Strict` redirect URI to <kbd>https://<em>gravity.company</em>/auth/oidc/callback</kbd>.
|
||||
- Select any available signing key.
|
||||
- **Configure Bindings** _(optional)_: Create a [binding](/docs/add-secure-apps/flows-stages/bindings/) (policy, group, or user) to manage the listing and access to applications on a user's **My applications** page.
|
||||
|
||||
3. Click **Submit** to save the new application and provider.
|
||||
|
||||
## Gravity configuration
|
||||
|
||||
1. From the **Gravity administrative interface**, navigate to **Cluster** > **Roles** and click **API**.
|
||||
2. Under the **OIDC** sub-section, configure the following values:
|
||||
|
||||
- **Issuer**: <kbd>https://<em>authentik.company</em>application/o/<em>application-slug</em>/</kbd>
|
||||
- **Client ID**: Your Client ID from authentik
|
||||
- **Client Secret**: Your Client Secret from authentik
|
||||
- **Redirect URL**: <kbd>https://<em>gravity.company</em>/auth/oidc/callback</kbd>
|
||||
|
||||
3. Click **Update** to save and apply your configuration.
|
||||
|
||||
## Configuration verification
|
||||
|
||||
To verify integration with authentik, log out of Gravity and attempt to visit the login page. You should be automatically redirected to authentik.
|
@ -114,6 +114,7 @@ module.exports = {
|
||||
"services/fortigate-admin/index",
|
||||
"services/fortigate-ssl/index",
|
||||
"services/fortimanager/index",
|
||||
"services/gravity/index",
|
||||
"services/opnsense/index",
|
||||
"services/pfsense/index",
|
||||
"services/netbird/index",
|
||||
|
Reference in New Issue
Block a user