website/integrations: added hoarder integration #12161
Open
+56
−0
Conversation
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
✅ Deploy Preview for authentik-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for authentik-storybook canceled.
|
4d62
reviewed
Nov 22, 2024
|
|
||
| ## What is Hoarder | ||
|
|
||
| > A self-hostable bookmark-everything app (links, notes and images) with AI-based automatic tagging and full text search |
There was a problem hiding this comment.
Suggested change
| > A self-hostable bookmark-everything app (links, notes and images) with AI-based automatic tagging and full text search | |
| > A self-hostable bookmark-everything app (links, notes and images) with AI-based automatic tagging and full-text search. |
|
|
||
| The following placeholders will be used: | ||
|
|
||
| - `hoarder.company` is the FQDN of the hoarder install. |
There was a problem hiding this comment.
Suggested change
| - `hoarder.company` is the FQDN of the hoarder install. | |
| - `hoarder.company` is the FQDN of the Hoarder install. |
| @@ -127,6 +127,7 @@ module.exports = { | |||
| "services/sonarr/index", | |||
| "services/tautulli/index", | |||
| "services/weblate/index", | |||
| "services/hoarder/index", | |||
There was a problem hiding this comment.
If I'm not mistaken, services in the sidebar should be sorted alphabetically.
| # DISABLE_SIGNUPS=true | ||
| ``` | ||
|
|
||
| Finally, restart the hoarder server and test your configuration. |
There was a problem hiding this comment.
Suggested change
| Finally, restart the hoarder server and test your configuration. | |
| Finally, restart the Hoarder server and test your configuration. |
|
|
||
| ## Hoarder configuration | ||
|
|
||
| In hoarder you'll need to add these environment variables: |
There was a problem hiding this comment.
Suggested change
| In hoarder you'll need to add these environment variables: | |
| In Hoarder you'll need to add these environment variables: |
|
|
||
| **Provider Settings** | ||
|
|
||
| In authentik under **Providers**, create an OAuth2/OpenID Provider with these settings: |
There was a problem hiding this comment.
You should tell the user where it is. Probably something similar to:
Suggested change
| In authentik under **Providers**, create an OAuth2/OpenID Provider with these settings: | |
| In authentik under **Applications** -> **Providers** of the **Admin interface**, create a new **OAuth2/OpenID Provider** with the desired settings. |
|
|
||
| **Application Settings** | ||
|
|
||
| Create an application that uses `hoarder` provider. Optionally apply access restrictions to the application. |
There was a problem hiding this comment.
You should tell the user where the provider tab is and how to create one
| OAUTH_CLIENT_ID=client_id_from_provider | ||
| OAUTH_CLIENT_SECRET=client_secret_from_provider | ||
| OAUTH_WELLKNOWN_URL=https://authentik.company/application/o/hoarder/.well-known/openid-configuration | ||
| OAUTH_PROVIDER_NAME=Authentik |
There was a problem hiding this comment.
Suggested change
| OAUTH_PROVIDER_NAME=Authentik | |
| OAUTH_PROVIDER_NAME=authentik |
|
|
||
| ```sh | ||
| NEXTAUTH_URL=https://hoarder.company | ||
| OAUTH_CLIENT_ID=client_id_from_provider |
There was a problem hiding this comment.
Suggested change
| OAUTH_CLIENT_ID=client_id_from_provider | |
| OAUTH_CLIENT_ID=<Client ID from authentik> |
| ```sh | ||
| NEXTAUTH_URL=https://hoarder.company | ||
| OAUTH_CLIENT_ID=client_id_from_provider | ||
| OAUTH_CLIENT_SECRET=client_secret_from_provider |
There was a problem hiding this comment.
Suggested change
| OAUTH_CLIENT_SECRET=client_secret_from_provider | |
| OAUTH_CLIENT_SECRET=<Client secret from authentik> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Details
Added Hoarder Integration to docs.