-
-
Notifications
You must be signed in to change notification settings - Fork 993
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
Open
nicedevil007
wants to merge
20
commits into
goauthentik:main
Choose a base branch
from
nicedevil007:pocketbase
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
511de48
initial release
nicedevil007 2b31de3
Ready for PR
nicedevil007 f133646
rollback to default package.json
nicedevil007 a995ff9
rollback to default again
nicedevil007 cb52a38
last one I missed...
nicedevil007 6d07e9f
index.mdx aktualisieren
nicedevil007 34fdcd3
index.mdx aktualisieren
nicedevil007 8446153
index.mdx aktualisieren
nicedevil007 125037d
index.mdx aktualisieren
nicedevil007 4989918
index.mdx aktualisieren
nicedevil007 3b7b181
index.mdx aktualisieren
nicedevil007 37e6e5b
index.mdx aktualisieren
nicedevil007 590520e
index.mdx aktualisieren
nicedevil007 8e3bdcf
index.mdx aktualisieren
nicedevil007 340a946
index.mdx aktualisieren
nicedevil007 4ef4c14
index.mdx aktualisieren
nicedevil007 1508e49
index.mdx aktualisieren
nicedevil007 9a983b3
index.mdx aktualisieren
nicedevil007 f56b962
Update because Fonts & Fonts styling guide
nicedevil007 458720b
same format as other PRs from 1-2weeks ago
nicedevil007 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
::: | ||
|
||
## 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 | ||
|
||
[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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Note to tana: This should be left as-is for now and I'll update format /button names later on.