Start document and update sidebar
This commit is contained in:
68
website/integrations/services/papra/index.mdx
Normal file
68
website/integrations/services/papra/index.mdx
Normal file
@ -0,0 +1,68 @@
|
||||
---
|
||||
title: Integrate with Papra
|
||||
sidebar_label: Papra
|
||||
support_level: community
|
||||
---
|
||||
|
||||
## What is Papra
|
||||
|
||||
> An open-source document management platform designed to help you organize, secure, and archive your files effortlessly.
|
||||
>
|
||||
> -- https://papra.app/
|
||||
|
||||
## Preparation
|
||||
|
||||
The following placeholders are used in this guide:
|
||||
|
||||
- `authentik.company` is the FQDN of the authentik installation.
|
||||
- `papra.company` is the FQDN of the Papra 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.
|
||||
:::
|
||||
|
||||
## authentik configuration
|
||||
|
||||
To support the integration of Papra 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 **Create with Provider** to create an application and provider pair. (Alternatively you can first create a provider separately, then create the application and connect it with the provider.)
|
||||
|
||||
- **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** and **Client Secret** values because they will be required later.
|
||||
- Set a `Strict` redirect URI to `https://papra.company/api/auth/oauth2/callback/:authentik`.
|
||||
- Select any available signing key.
|
||||
- **Configure Bindings** _(optional)_: you can 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.
|
||||
|
||||
## Papra configuration
|
||||
|
||||
Add the following to your Papra environment variables:
|
||||
|
||||
```yaml
|
||||
AUTH_PROVIDERS_CUSTOMS='[
|
||||
{
|
||||
"providerId": "custom-oauth2",
|
||||
"providerName": "Custom OAuth2",
|
||||
"providerIconUrl": "https://api.iconify.design/tabler:login-2.svg",
|
||||
"clientId": "your-client-id",
|
||||
"clientSecret": "your-client-secret",
|
||||
"type": "oidc",
|
||||
"discoveryUrl": "https://your-provider.tld/.well-known/openid-configuration",
|
||||
"scopes": ["openid", "profile", "email"]
|
||||
}
|
||||
]'
|
||||
```
|
||||
|
||||
## Configuration verification
|
||||
|
||||
To verify the integration with Papra, log out and attempt to log back in using..
|
||||
|
||||
## Resources
|
||||
|
||||
- [Papra - Setup Custom OAuth2 Providers Documentation](https://docs.papra.app/guides/setup-custom-oauth2-providers/)
|
@ -87,6 +87,7 @@ const items = [
|
||||
"services/outline/index",
|
||||
"services/paperless-ng/index",
|
||||
"services/paperless-ngx/index",
|
||||
"services/papra/index",
|
||||
"services/snipe-it/index",
|
||||
"services/tandoor/index",
|
||||
"services/wiki-js/index",
|
||||
|
Reference in New Issue
Block a user