diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md new file mode 100644 index 000000000000..f96b93553995 --- /dev/null +++ b/website/integrations/services/hoarder/index.md @@ -0,0 +1,56 @@ +--- +title: Integrate with Hoarder +sidebar_label: Hoarder +--- + +# Hoarder + +Support level: Community + +## What is Hoarder + +> A self-hostable bookmark-everything app (links, notes and images) with AI-based automatic tagging and full-text search. +> +> -- https://hoarder.app/ + +## Preparation + +The following placeholders will be used: + +- `hoarder.company` is the FQDN of the Hoarder install. +- `authentik.company` is the FQDN of the authentik install. + +## authentik configuration + +### Provider settings + +In authentik, under **Applications** -> **Providers** of the **Admin interface**, create a new **OAuth2/OpenID Provider** with the desired settings. + +- Name: `hoarder` +- Redirect URI: `https://hoarder.company/api/auth/callback/custom` + +Everything else is up to you, just make sure to grab the client ID and the client secret! + +### Application settings + +In authentik, under **Applications** -> **Applications** of the **Admin interface**, create a new Application with the **Create** button that uses `hoarder` provider. +Optionally apply access restrictions to the application. + +## Hoarder configuration + +In Hoarder, you'll need to add these environment variables: + +```sh +NEXTAUTH_URL=https://hoarder.company +OAUTH_CLIENT_ID= +OAUTH_CLIENT_SECRET= +OAUTH_WELLKNOWN_URL=https://authentik.company/application/o/hoarder/.well-known/openid-configuration +OAUTH_PROVIDER_NAME=authentik +OAUTH_ALLOW_DANGEROUS_EMAIL_ACCOUNT_LINKING=true +# Optional: You can add this if you only want to allow login with Authentik +# DISABLE_PASSWORD_AUTH=true +# Optional but highly recommended: +# DISABLE_SIGNUPS=true +``` + +Finally, restart the Hoarder server and test your configuration. diff --git a/website/sidebarsIntegrations.js b/website/sidebarsIntegrations.js index 83c0e2030182..e0070c9660f5 100644 --- a/website/sidebarsIntegrations.js +++ b/website/sidebarsIntegrations.js @@ -122,6 +122,7 @@ module.exports = { "services/frappe/index", "services/freshrss/index", "services/gravitee/index", + "services/hoarder/index", "services/home-assistant/index", "services/immich/index", "services/jellyfin/index",