mirror of
https://github.com/goauthentik/authentik
synced 2026-04-27 18:07:15 +02:00
6ed5cb5249
* website/integrations: rename "Create with Provider" to "New Application" The application list page now uses a split-button labeled "New Application" instead of the old "Create with Provider" dropdown. Update all 113 integration guides to match. * website/docs: update flow, stage, and policy button labels - "Create" → "New Flow", "New Stage", "New Policy" for trigger buttons - "Finish" → "Create Flow", "Create Stage", "Create Policy" for submit - "Create and bind stage" → "New Stage" / "Bind Existing Stage" - "Create" (binding submit) → "Create Stage Binding" * website/docs: update provider button labels - "Create" → "New Provider" for trigger buttons - "Create with Provider" → "New Application" in RAC docs - "Create" → "New Property Mapping", "New RAC Endpoint", "New Prompt" for related entity creation * website/docs: update directory button labels - "Create" → "New Source" for federation/social login pages - "Create" → "New Role", submit → "Create Role" - "Create" → "New Invitation" - Policy binding submit → "Create Policy Binding" * website/docs: update endpoint device and system management button labels - "Create" → "New Endpoint Connector", "New Enrollment Token", "New Device Access Group", "New Flow" - Submit → "Create Device Access Group" - "Create" → "New Notification Rule", "New Notification Transport" - Binding submit → "Create Policy Binding" * Reorganize policy documentation * website/docs: address policy docs review feedback * post-rebase * website/docs: Reorganize policy documentation -- Revisions (#21601) * apply suggestions * Fix escaped. * Fix whitespace. * Update button label. * Fix phrasing. * Fix phrasing. * Clean up stragglers. * Format. --------- Co-authored-by: Dominic R <dominic@sdko.org>
113 lines
5.4 KiB
Markdown
113 lines
5.4 KiB
Markdown
---
|
|
title: Integrate with pgAdmin
|
|
sidebar_label: pgAdmin
|
|
support_level: community
|
|
---
|
|
|
|
## What is pgAdmin
|
|
|
|
> pgAdmin is a management tool for PostgreSQL and derivative relational databases such as EnterpriseDB's EDB Advanced Server. It may be run either as a web or desktop application.
|
|
>
|
|
> -- https://www.pgadmin.org/
|
|
|
|
:::info
|
|
This is based on authentik 2024.12.2 and pgAdmin4 8.14
|
|
:::
|
|
|
|
## Preparation
|
|
|
|
The following placeholders are used in this guide:
|
|
|
|
- `pgadmin.company` is the FQDN of the pgAdmin installation.
|
|
- `authentik.company` is the FQDN of the authentik installation.
|
|
|
|
:::info
|
|
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.
|
|
:::
|
|
|
|
## authentik configuration
|
|
|
|
To support the integration of pgAdmin 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 administrator and open the authentik Admin interface.
|
|
2. Navigate to **Applications** > **Applications** and click **New Application** to open the application wizard.
|
|
- **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), the authorization flow to use for this provider, and the following required configurations.
|
|
- Note the **Client ID**, **Client Secret**, and **slug** values because they will be required later.
|
|
- Set a `Strict` redirect URI to `https://pgadmin.company/oauth2/authorize`.
|
|
- Select any available signing key.
|
|
- **Configure Bindings** _(optional)_: you can create a [binding](/docs/add-secure-apps/bindings-overview/) (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.
|
|
|
|
## pgAdmin OAuth Configuration
|
|
|
|
To configure OAuth in pgAdmin, you can either use the `config_local.py` file or set environment variables if you are deploying pgAdmin in a containerized setup.
|
|
|
|
### Using `config_local.py`
|
|
|
|
1. Locate or create the `config_local.py` file in the `/pgadmin4/` directory.
|
|
- If the file does not exist, create it manually.
|
|
|
|
2. Add the following configuration settings to `config_local.py`:
|
|
|
|
```python
|
|
AUTHENTICATION_SOURCES = ['oauth2', 'internal']
|
|
OAUTH2_AUTO_CREATE_USER = True
|
|
OAUTH2_CONFIG = [{
|
|
'OAUTH2_NAME': 'authentik',
|
|
'OAUTH2_DISPLAY_NAME': 'authentik',
|
|
'OAUTH2_CLIENT_ID': '<Client ID from authentik>',
|
|
'OAUTH2_CLIENT_SECRET': '<Client secret from authentik>',
|
|
'OAUTH2_TOKEN_URL': 'https://authentik.company/application/o/token/',
|
|
'OAUTH2_AUTHORIZATION_URL': 'https://authentik.company/application/o/authorize/',
|
|
'OAUTH2_API_BASE_URL': 'https://authentik.company/',
|
|
'OAUTH2_USERINFO_ENDPOINT': 'https://authentik.company/application/o/userinfo/',
|
|
'OAUTH2_SERVER_METADATA_URL': 'https://authentik.company/application/o/<application_slug>/.well-known/openid-configuration',
|
|
'OAUTH2_SCOPE': 'openid email profile',
|
|
'OAUTH2_ICON': '<Fontawesome icon key (e.g., fa-key)>',
|
|
'OAUTH2_BUTTON_COLOR': '<Hexadecimal color code for the login button>'
|
|
}]
|
|
```
|
|
|
|
3. Save the file and restart pgAdmin for the changes to take effect.
|
|
|
|
:::info
|
|
You must restart pgAdmin every time you make changes to `config_local.py`.
|
|
:::
|
|
|
|
### Using Environment Variables for Containerized Deployments
|
|
|
|
For deployments using Docker or Kubernetes, you can configure OAuth using the following environment variables:
|
|
|
|
1. Set these environment variables in your container:
|
|
|
|
```bash
|
|
PGADMIN_CONFIG_AUTHENTICATION_SOURCES="['oauth2', 'internal']"
|
|
PGADMIN_CONFIG_OAUTH2_AUTO_CREATE_USER=True
|
|
PGADMIN_CONFIG_OAUTH2_CONFIG="[{'OAUTH2_NAME':'authentik','OAUTH2_DISPLAY_NAME':'Login with authentik','OAUTH2_CLIENT_ID':'<Client ID from authentik>','OAUTH2_CLIENT_SECRET':'<Client secret from authentik>','OAUTH2_TOKEN_URL':'https://authentik.company/application/o/token/','OAUTH2_AUTHORIZATION_URL':'https://authentik.company/application/o/authorize/','OAUTH2_API_BASE_URL':'https://authentik.company/','OAUTH2_USERINFO_ENDPOINT':'https://authentik.company/application/o/userinfo/','OAUTH2_SERVER_METADATA_URL':'https://authentik.company/application/o/<application_slug>/.well-known/openid-configuration','OAUTH2_SCOPE':'openid email profile','OAUTH2_ICON':'<Fontawesome icon key (e.g., fa-key)>','OAUTH2_BUTTON_COLOR':'<Hexadecimal color code for the login button>'}]"
|
|
```
|
|
|
|
### General Notes
|
|
|
|
- To **only allow OAuth2 login**, set:
|
|
|
|
```python
|
|
AUTHENTICATION_SOURCES = ['oauth2']
|
|
```
|
|
|
|
Ensure that you promote at least one user to an administrator before disabling the internal authentication.
|
|
|
|
- To **disable automatic user creation**, set:
|
|
```python
|
|
OAUTH2_AUTO_CREATE_USER = False
|
|
```
|
|
Setting this value to `False` disables automatic user creation. This ensures that only the first signed-in user is registered.
|
|
|
|
## Configuration verification
|
|
|
|
To confirm that authentik is properly configured with pgAdmin, log out and log back in via authentik. A new button should have appeared on the login page.
|