-
-
Notifications
You must be signed in to change notification settings - Fork 997
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
website/integrations: Pocketbase #12906
base: main
Are you sure you want to change the base?
Changes from all commits
511de48
2b31de3
f133646
a995ff9
cb52a38
6d07e9f
34fdcd3
8446153
125037d
4989918
3b7b181
37e6e5b
590520e
8e3bdcf
340a946
4ef4c14
1508e49
9a983b3
f56b962
458720b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
--- | ||
title: Integrate with PocketBase | ||
sidebar_label: PocketBase | ||
--- | ||
|
||
# Integrate With PocketBase | ||
|
||
<span class="badge badge--secondary">Support level: Community</span> | ||
|
||
## What is PocketBase | ||
|
||
> PocketBase is a lightweight backend solution that provides a built-in database, authentication, and file storage. | ||
> It allows developers to quickly set up and manage backend services without complex configurations. | ||
> With its simple API and easy-to-use dashboard, it's perfect for small projects, prototypes, or even full-scale applications. | ||
> | ||
> -- https://pocketbase.io/ | ||
> | ||
> This guide explains how to configure PocketBase so that your application uses it in the backend, enabling authentik as the OAuth provider for login. | ||
|
||
:::note | ||
If you are using an application that relies on PocketBase as its backend, you can replace the placeholders used here with the application's name. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Only the |
||
::: | ||
|
||
## Preparation | ||
|
||
The following placeholders are used in this guide: | ||
|
||
- `pocketbase.company` is the FQDN of the PocketBase 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. | ||
::: | ||
|
||
## authentik configuration | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Note to tana: This should be left as-is for now and I'll update format /button names later on. |
||
|
||
[Create](https://docs.goauthentik.io/docs/add-secure-apps/applications/manage_apps#add-new-applications) an OAuth2/OpenID provider and an application in authentik. Use the following parameters for the OAuth2/OpenID provider: | ||
|
||
1. In the authentik Admin interface, navigate to **Applications** -> **Applications**. | ||
2. Use the wizard to create a new application and provider. During this process: | ||
- Note the **Client ID**, **Client Secret**, and **slug** values for later use. | ||
- Select implicit or explicit authorization flow as desired. | ||
- Set the redirect URI to <kbd>https://<em>pocketbase.company</em>/api/oauth2-redirect</kbd>. | ||
- Select any available signing key. | ||
|
||
## PocketBase configuration | ||
|
||
1. Sign in to PocketBase and access the superusers dashboard by navigating to <kbd>https://<em>pocketbase.company</em>/_/#/settings</kbd>. | ||
2. Toggle off **Hide collection create and edit controls**," then click the **Save changes** button. | ||
3. Open the **users** collection by clicking the **Collections** icon on the sidebar or head to <kbd>https://<em>pocketbase.company</em>/_/#/collections?collection=pb_users_auth</kbd>. | ||
4. Click the gear icon next to the collection's name, then select the **Options** tab in the popup on the right. | ||
5. Enable the **OAuth2** authentication method by clicking the **OAuth2** tab and toggling **Enable**. | ||
6. Click **+ Add provider**, then select **OpenID Connect**. | ||
7. Enter the following details from the authentik provider: | ||
- Set **Client ID** to the Client ID copied from authentik. | ||
- Set **Client secret** to the Client Secret copied from authentik. | ||
- Set **Display name** to `authentik`. | ||
- Set **Auth URL** to <kbd>https://<em>authentik.company</em>/application/o/authorize/</kbd>. | ||
- Set **Token URL** to <kbd>https://<em>authentik.company</em>/application/o/token/</kbd>. | ||
- Make sure **Fetch user info from** is set to `User info URL`, then set **User info URL** to <kbd>https://<em>authentik.company</em>/application/o/userinfo/</kbd> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Would it be possible to add a Configuration validation section as outlined in the template? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sentence is not part of the template outlined in the documentation.