From b64e6f6e7f016d07347af230425f437f2ea8d4d2 Mon Sep 17 00:00:00 2001 From: Miguel Palau Zarza Date: Fri, 22 Nov 2024 11:28:31 -0600 Subject: [PATCH 01/21] add Hoarder integration --- .../integrations/services/hoarder/index.md | 55 +++++++++++++++++++ website/sidebarsIntegrations.js | 1 + 2 files changed, 56 insertions(+) create mode 100644 website/integrations/services/hoarder/index.md diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md new file mode 100644 index 000000000000..785116be4c0c --- /dev/null +++ b/website/integrations/services/hoarder/index.md @@ -0,0 +1,55 @@ +--- +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 **Providers**, create an OAuth2/OpenID Provider with these 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** + +Create an application 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=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 +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 39d1c0dca54d..b97ed9307f9e 100644 --- a/website/sidebarsIntegrations.js +++ b/website/sidebarsIntegrations.js @@ -127,6 +127,7 @@ module.exports = { "services/sonarr/index", "services/tautulli/index", "services/weblate/index", + "services/hoarder/index", ], }, { From f6908115d316ce354f2bad6962cb0e6277e5fdb7 Mon Sep 17 00:00:00 2001 From: Miguel Palau Date: Sun, 24 Nov 2024 16:28:11 -0600 Subject: [PATCH 02/21] Update website/integrations/services/hoarder/index.md Co-authored-by: 4d62 Signed-off-by: Miguel Palau --- website/integrations/services/hoarder/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index 785116be4c0c..86768c4269f9 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -9,7 +9,7 @@ sidebar_label: Hoarder ## What is Hoarder -> 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/ From 2b27fca1ee9b5d8c49c55af955fe190b851015a5 Mon Sep 17 00:00:00 2001 From: Miguel Palau Date: Sun, 24 Nov 2024 16:28:20 -0600 Subject: [PATCH 03/21] Update website/integrations/services/hoarder/index.md Co-authored-by: 4d62 Signed-off-by: Miguel Palau --- website/integrations/services/hoarder/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index 86768c4269f9..adf57ff82285 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -17,7 +17,7 @@ sidebar_label: Hoarder The following placeholders will be used: -- `hoarder.company` is the FQDN of the hoarder install. +- `hoarder.company` is the FQDN of the Hoarder install. - `authentik.company` is the FQDN of the authentik install. ## Authentik configuration From 5a83cd916fa534867cb3c3836dc98b98ec26992d Mon Sep 17 00:00:00 2001 From: Miguel Palau Date: Sun, 24 Nov 2024 16:29:37 -0600 Subject: [PATCH 04/21] Update website/integrations/services/hoarder/index.md Co-authored-by: 4d62 Signed-off-by: Miguel Palau --- website/integrations/services/hoarder/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index adf57ff82285..e1d3c2512f4f 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -42,7 +42,7 @@ In hoarder you'll need to add these environment variables: ```sh NEXTAUTH_URL=https://hoarder.company OAUTH_CLIENT_ID=client_id_from_provider -OAUTH_CLIENT_SECRET=client_secret_from_provider +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 From ba225da0b93d552efbf57fc253e6a2f220d13902 Mon Sep 17 00:00:00 2001 From: Miguel Palau Date: Sun, 24 Nov 2024 16:29:45 -0600 Subject: [PATCH 05/21] Update website/integrations/services/hoarder/index.md Co-authored-by: 4d62 Signed-off-by: Miguel Palau --- website/integrations/services/hoarder/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index e1d3c2512f4f..9639e1451e55 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -41,7 +41,7 @@ In hoarder you'll need to add these environment variables: ```sh NEXTAUTH_URL=https://hoarder.company -OAUTH_CLIENT_ID=client_id_from_provider +OAUTH_CLIENT_ID= OAUTH_CLIENT_SECRET= OAUTH_WELLKNOWN_URL=https://authentik.company/application/o/hoarder/.well-known/openid-configuration OAUTH_PROVIDER_NAME=Authentik From 2ea574219f1f69fe10cf881073058c6c43b32a13 Mon Sep 17 00:00:00 2001 From: Miguel Palau Date: Sun, 24 Nov 2024 16:29:53 -0600 Subject: [PATCH 06/21] Update website/integrations/services/hoarder/index.md Co-authored-by: 4d62 Signed-off-by: Miguel Palau --- website/integrations/services/hoarder/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index 9639e1451e55..03cb4d62b08f 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -44,7 +44,7 @@ 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_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 From 5bddfe1148562ff087abfdd18c8033142d4a2900 Mon Sep 17 00:00:00 2001 From: Miguel Palau Date: Sun, 24 Nov 2024 16:30:01 -0600 Subject: [PATCH 07/21] Update website/integrations/services/hoarder/index.md Co-authored-by: 4d62 Signed-off-by: Miguel Palau --- website/integrations/services/hoarder/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index 03cb4d62b08f..9de63723d87b 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -37,7 +37,7 @@ Create an application that uses `hoarder` provider. Optionally apply access rest ## Hoarder configuration -In hoarder you'll need to add these environment variables: +In Hoarder you'll need to add these environment variables: ```sh NEXTAUTH_URL=https://hoarder.company From 99109f7c05cde29d27f6d16e3ca782d7ac2e036f Mon Sep 17 00:00:00 2001 From: Miguel Palau Date: Sun, 24 Nov 2024 16:30:19 -0600 Subject: [PATCH 08/21] Update website/integrations/services/hoarder/index.md Co-authored-by: 4d62 Signed-off-by: Miguel Palau --- website/integrations/services/hoarder/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index 9de63723d87b..b0ef45ece39d 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -24,7 +24,7 @@ The following placeholders will be used: **Provider Settings** -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. - Name: `hoarder` - Redirect URI: `https://hoarder.company/api/auth/callback/custom` From 756071cc0a11c5d45ca2852b2229ae020d57e8a1 Mon Sep 17 00:00:00 2001 From: Miguel Palau Date: Sun, 24 Nov 2024 16:30:29 -0600 Subject: [PATCH 09/21] Update website/integrations/services/hoarder/index.md Co-authored-by: 4d62 Signed-off-by: Miguel Palau --- website/integrations/services/hoarder/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index b0ef45ece39d..7834445448d1 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -52,4 +52,4 @@ OAUTH_ALLOW_DANGEROUS_EMAIL_ACCOUNT_LINKING=true # DISABLE_SIGNUPS=true ``` -Finally, restart the hoarder server and test your configuration. +Finally, restart the Hoarder server and test your configuration. From 83a2ca0481bfc7bef9a7784fa40e7b73f7edebbe Mon Sep 17 00:00:00 2001 From: Miguel Palau Zarza Date: Sun, 24 Nov 2024 16:34:37 -0600 Subject: [PATCH 10/21] hoarder sorted alphabetically --- website/sidebarsIntegrations.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/sidebarsIntegrations.js b/website/sidebarsIntegrations.js index b97ed9307f9e..4d6c85e3958b 100644 --- a/website/sidebarsIntegrations.js +++ b/website/sidebarsIntegrations.js @@ -119,6 +119,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", @@ -127,7 +128,6 @@ module.exports = { "services/sonarr/index", "services/tautulli/index", "services/weblate/index", - "services/hoarder/index", ], }, { From 9f0e9513c289a4e4593434ef67e3fd6008ddbfc0 Mon Sep 17 00:00:00 2001 From: Miguel Palau Zarza Date: Sun, 24 Nov 2024 16:37:04 -0600 Subject: [PATCH 11/21] more detailed way of using an application --- website/integrations/services/hoarder/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index 7834445448d1..37c0d3b192e8 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -33,7 +33,8 @@ Everything else is up to you, just make sure to grab the client ID and the clien **Application Settings** -Create an application that uses `hoarder` provider. Optionally apply access restrictions to the application. +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 From 64a3ef2557bbb68b1269a25878c76768525dcea2 Mon Sep 17 00:00:00 2001 From: Miguel Palau Date: Sun, 24 Nov 2024 21:48:58 -0600 Subject: [PATCH 12/21] Update index.md Co-authored-by: 4d62 Signed-off-by: Miguel Palau --- website/integrations/services/hoarder/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index 37c0d3b192e8..b43f06f447ba 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -38,7 +38,7 @@ Optionally apply access restrictions to the application. ## Hoarder configuration -In Hoarder you'll need to add these environment variables: +In Hoarder, you'll need to add these environment variables: ```sh NEXTAUTH_URL=https://hoarder.company From 215de6e4f0af04184b1111cdc5a3c9aed9401472 Mon Sep 17 00:00:00 2001 From: Miguel Palau Date: Sun, 24 Nov 2024 21:49:07 -0600 Subject: [PATCH 13/21] Update index.md Co-authored-by: 4d62 Signed-off-by: Miguel Palau --- website/integrations/services/hoarder/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index b43f06f447ba..ec1d219f7cb2 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -22,7 +22,7 @@ The following placeholders will be used: ## Authentik configuration -**Provider Settings** +### Provider Settings In authentik under **Applications** -> **Providers** of the **Admin interface**, create a new **OAuth2/OpenID Provider** with the desired settings. From ce984e6c80fe2d1b4929ed1b465c0793d1240c45 Mon Sep 17 00:00:00 2001 From: Miguel Palau Date: Sun, 24 Nov 2024 21:49:14 -0600 Subject: [PATCH 14/21] Update index.md Co-authored-by: 4d62 Signed-off-by: Miguel Palau --- website/integrations/services/hoarder/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index ec1d219f7cb2..98a29105265d 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -31,7 +31,7 @@ In authentik under **Applications** -> **Providers** of the **Admin interface**, Everything else is up to you, just make sure to grab the client ID and the client secret! -**Application Settings** +### 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. From 8aa064f3cf2eb1e7e3d714debb2e34fe93a007fd Mon Sep 17 00:00:00 2001 From: Miguel Palau Date: Sun, 24 Nov 2024 21:49:22 -0600 Subject: [PATCH 15/21] Update index.md Co-authored-by: 4d62 Signed-off-by: Miguel Palau --- website/integrations/services/hoarder/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index 98a29105265d..c0c4c62b8509 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -33,7 +33,7 @@ Everything else is up to you, just make sure to grab the client ID and the clien ### Application Settings -In authentik under **Applications** -> **Applications** of the **Admin interface**, create a new Application with the **Create** button that uses `hoarder` provider. +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 From 258ac3284d9ea88944fc69f43afb63aa246595d6 Mon Sep 17 00:00:00 2001 From: Miguel Palau Date: Sun, 24 Nov 2024 21:49:28 -0600 Subject: [PATCH 16/21] Update index.md Co-authored-by: 4d62 Signed-off-by: Miguel Palau --- website/integrations/services/hoarder/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index c0c4c62b8509..bc3f8794abc7 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -24,7 +24,7 @@ The following placeholders will be used: ### Provider Settings -In authentik under **Applications** -> **Providers** of the **Admin interface**, create a new **OAuth2/OpenID Provider** with the desired 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` From d1a01fef9472c59ff7d735ff9a00acc278436659 Mon Sep 17 00:00:00 2001 From: Miguel Palau Date: Tue, 3 Dec 2024 17:13:52 -0600 Subject: [PATCH 17/21] Update website/integrations/services/hoarder/index.md Co-authored-by: Tana M Berry Signed-off-by: Miguel Palau --- website/integrations/services/hoarder/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index bc3f8794abc7..14dd231d2079 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -31,7 +31,7 @@ In authentik, under **Applications** -> **Providers** of the **Admin interface** Everything else is up to you, just make sure to grab the client ID and the client secret! -### Application Settings +### 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. From 357c58a82b79ce834e6421a9e7e45ffe47c73e32 Mon Sep 17 00:00:00 2001 From: Miguel Palau Date: Tue, 3 Dec 2024 17:14:01 -0600 Subject: [PATCH 18/21] Update website/integrations/services/hoarder/index.md Co-authored-by: Tana M Berry Signed-off-by: Miguel Palau --- website/integrations/services/hoarder/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index 14dd231d2079..003328ad1c3c 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -20,7 +20,7 @@ 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 +## authentik configuration ### Provider Settings From a9a81cf7e72a087eec4ba89f91dd72a22116c2c0 Mon Sep 17 00:00:00 2001 From: Miguel Palau Date: Tue, 3 Dec 2024 17:14:26 -0600 Subject: [PATCH 19/21] Update website/integrations/services/hoarder/index.md Co-authored-by: Tana M Berry Signed-off-by: Miguel Palau --- website/integrations/services/hoarder/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index 003328ad1c3c..fe46392833ca 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -22,7 +22,7 @@ The following placeholders will be used: ## authentik configuration -### Provider Settings +### Provider settings In authentik, under **Applications** -> **Providers** of the **Admin interface**, create a new **OAuth2/OpenID Provider** with the desired settings. From 2f83caaa9828bb5a3741bb6a98fbf2198dfb8871 Mon Sep 17 00:00:00 2001 From: Marc 'risson' Schmitt Date: Tue, 17 Dec 2024 16:28:27 +0100 Subject: [PATCH 20/21] test From 573e04fc8ac29f5c3186ff6734e7b32d53475c70 Mon Sep 17 00:00:00 2001 From: Tana M Berry Date: Tue, 17 Dec 2024 09:47:33 -0600 Subject: [PATCH 21/21] ran make website --- website/integrations/services/hoarder/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/website/integrations/services/hoarder/index.md b/website/integrations/services/hoarder/index.md index fe46392833ca..f96b93553995 100644 --- a/website/integrations/services/hoarder/index.md +++ b/website/integrations/services/hoarder/index.md @@ -17,8 +17,8 @@ sidebar_label: Hoarder The following placeholders will be used: -- `hoarder.company` is the FQDN of the Hoarder install. -- `authentik.company` is the FQDN of the authentik install. +- `hoarder.company` is the FQDN of the Hoarder install. +- `authentik.company` is the FQDN of the authentik install. ## authentik configuration @@ -26,8 +26,8 @@ The following placeholders will be used: 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` +- 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!