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>
95 lines
3.6 KiB
Markdown
95 lines
3.6 KiB
Markdown
---
|
|
title: Integrate with Calibre-Web
|
|
sidebar_label: Calibre-Web
|
|
support_level: community
|
|
---
|
|
|
|
## What is Calibre-Web
|
|
|
|
> Calibre-Web is a web app that offers an interface for browsing, reading, and downloading eBooks using a valid Calibre database.
|
|
>
|
|
> -- https://github.com/janeczku/calibre-web
|
|
|
|
## Preparation
|
|
|
|
The following placeholders are used in this guide:
|
|
|
|
- `calibreweb.company` is the FQDN of the Calibre-Web 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 Calibre-Web with authentik, you need to create an application/provider pair and a corresponding group 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 LDAP Provider as the provider type.
|
|
|
|
- **Configure the Provider**: provide a name (or accept the auto-provided name) and set the authorization flow to use for this provider.
|
|
|
|
- **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.
|
|
|
|
### Create a group in authentik
|
|
|
|
Create a group that will grant access to Calibre-Web.
|
|
|
|
1. Navigate to **Directory** > **Groups** and click **Create**.
|
|
|
|
- **Name**: provide a name (e.g. `Calibre-Web`).
|
|
|
|
2. Click **Create**.
|
|
|
|
### Add users to the group
|
|
|
|
Add the users that require access to the newly created group.
|
|
|
|
1. Navigate to **Directory** > **Groups** and click on the name of the group (e.g. `Calibre-Web`) that was just created.
|
|
|
|
2. Navigate to the **Users** tab and click **Add existing user**.
|
|
|
|
3. Click **+**.
|
|
|
|
4. Select the user that requires access and click **Add**.
|
|
|
|
5. Click **Add**.
|
|
|
|
## Calibre-Web configuration
|
|
|
|
1. Navigate to **Admin** > **Edit Basic Configuration** and click on **Feature Configuration** and set the following options:
|
|
|
|
- Login Type: `Use LDAP Authentication`
|
|
- LDAP Server: `authentik.company`
|
|
- LDAP Server Port: `389`
|
|
- LDAP Encryption: `None`
|
|
- LDAP Authentication: `Simple`
|
|
- LDAP Administrator Username: `cn=<authentik_administrator_username>,ou=users,dc=goauthentik,dc=io` (e.g. `cn=akadmin,ou=users,dc=goauthentik,dc=io`)
|
|
- LDAP Administrator Password: `<authentik_administrator_password>`
|
|
- LDAP Distinguished Name (DN): `dc=ldap,dc=goauthentik,dc=io`
|
|
- LDAP User Object Filter: `(&(objectclass=user)(cn=%s))`
|
|
- LDAP Server is OpenLDAP?: `true`
|
|
- LDAP Group Object Filter: `(&(objectclass=group)(cn=%s))`
|
|
- LDAP Group Name: `<group_name>` (e.g. `Calibre-Web`)
|
|
- LDAP Group Members Field: `member`
|
|
- LDAP Member User Filter Detection: `Autodetect`
|
|
|
|
2. Click **Save**.
|
|
|
|
3. Navigate to **Admin** and click **Import LDAP Users**
|
|
|
|
4. Once the user is imported from authentik, click **Edit Users** and give the user the desired permissions by checking the relevant checkboxes.
|
|
|
|
## Configuration verification
|
|
|
|
To confirm that authentik is properly configured with _Calibre-Web_, log out and log back in using the credentials of a user that is a member of the LDAP group (e.g. `Calibre-Web`).
|