website/integrations: rename Hoarder to Karakeep (#13789)
* Hoarder renamed to karakeep The Hoarder app has been renamed to Karakeep recently. https://www.reddit.com/r/selfhosted/comments/1js667o/hoarder_is_rebranding_to_karakeep/ Signed-off-by: petrsimunek <49954958+petrsimunek@users.noreply.github.com> * folder hoarder renamed to karakeep * sidebar changed from hoarder to karakeep --------- Signed-off-by: petrsimunek <49954958+petrsimunek@users.noreply.github.com>
This commit is contained in:
@ -1,20 +1,20 @@
|
|||||||
---
|
---
|
||||||
title: Integrate with Hoarder
|
title: Integrate with Karakeep
|
||||||
sidebar_label: Hoarder
|
sidebar_label: Karakeep
|
||||||
support_level: community
|
support_level: community
|
||||||
---
|
---
|
||||||
|
|
||||||
## What is Hoarder
|
## What is Karakeep
|
||||||
|
|
||||||
> 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.
|
||||||
>
|
>
|
||||||
> -- https://hoarder.app/
|
> -- https://karakeep.app/
|
||||||
|
|
||||||
## Preparation
|
## Preparation
|
||||||
|
|
||||||
The following placeholders are used in this guide:
|
The following placeholders are used in this guide:
|
||||||
|
|
||||||
- `hoarder.company` is the FQDN of the Hoarder installation.
|
- `karakeep.company` is the FQDN of the Karakeep installation.
|
||||||
- `authentik.company` is the FQDN of the authentik installation.
|
- `authentik.company` is the FQDN of the authentik installation.
|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
@ -23,7 +23,7 @@ This documentation lists only the settings that you need to change from their de
|
|||||||
|
|
||||||
## authentik configuration
|
## authentik configuration
|
||||||
|
|
||||||
To support the integration of Hoarder with authentik, you need to create an application/provider pair in authentik.
|
To support the integration of Karakeep with authentik, you need to create an application/provider pair in authentik.
|
||||||
|
|
||||||
### Create an application and provider in authentik
|
### Create an application and provider in authentik
|
||||||
|
|
||||||
@ -34,21 +34,21 @@ To support the integration of Hoarder with authentik, you need to create an appl
|
|||||||
- **Choose a Provider type**: select **OAuth2/OpenID Connect** as the provider type.
|
- **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.
|
- **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**,**Client Secret**, and **slug** values because they will be required later.
|
- Note the **Client ID**,**Client Secret**, and **slug** values because they will be required later.
|
||||||
- Set a `Strict` redirect URI to <kbd>https://<em>hoarder.company</em>/api/auth/callback/custom</kbd>.
|
- Set a `Strict` redirect URI to <kbd>https://<em>karakeep.company</em>/api/auth/callback/custom</kbd>.
|
||||||
- Select any available signing key.
|
- 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.
|
- **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.
|
3. Click **Submit** to save the new application and provider.
|
||||||
|
|
||||||
## Hoarder configuration
|
## Karakeep configuration
|
||||||
|
|
||||||
In Hoarder, you'll need to add these environment variables:
|
In Karakeep, you'll need to add these environment variables:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
NEXTAUTH_URL=https://hoarder.company
|
NEXTAUTH_URL=https://karakeep.company
|
||||||
OAUTH_CLIENT_ID=<Client ID from authentik>
|
OAUTH_CLIENT_ID=<Client ID from authentik>
|
||||||
OAUTH_CLIENT_SECRET=<Client secret from authentik>
|
OAUTH_CLIENT_SECRET=<Client secret from authentik>
|
||||||
OAUTH_WELLKNOWN_URL=https://authentik.company/application/o/hoarder/.well-known/openid-configuration
|
OAUTH_WELLKNOWN_URL=https://authentik.company/application/o/karakeep/.well-known/openid-configuration
|
||||||
OAUTH_PROVIDER_NAME=authentik
|
OAUTH_PROVIDER_NAME=authentik
|
||||||
OAUTH_ALLOW_DANGEROUS_EMAIL_ACCOUNT_LINKING=true
|
OAUTH_ALLOW_DANGEROUS_EMAIL_ACCOUNT_LINKING=true
|
||||||
# Optional: You can add this if you only want to allow login with Authentik
|
# Optional: You can add this if you only want to allow login with Authentik
|
||||||
@ -57,4 +57,4 @@ OAUTH_ALLOW_DANGEROUS_EMAIL_ACCOUNT_LINKING=true
|
|||||||
# DISABLE_SIGNUPS=true
|
# DISABLE_SIGNUPS=true
|
||||||
```
|
```
|
||||||
|
|
||||||
Finally, restart the Hoarder server and test your configuration.
|
Finally, restart the Karakeep server and test your configuration.
|
||||||
@ -140,7 +140,7 @@ module.exports = {
|
|||||||
"services/frappe/index",
|
"services/frappe/index",
|
||||||
"services/freshrss/index",
|
"services/freshrss/index",
|
||||||
"services/gravitee/index",
|
"services/gravitee/index",
|
||||||
"services/hoarder/index",
|
"services/karakeep/index",
|
||||||
"services/home-assistant/index",
|
"services/home-assistant/index",
|
||||||
"services/immich/index",
|
"services/immich/index",
|
||||||
"services/jellyfin/index",
|
"services/jellyfin/index",
|
||||||
|
|||||||
Reference in New Issue
Block a user