Skip to content
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.

Sign up for GitHub

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

Jump to bottom

website/integrations: added hoarder integration #12161

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+56 −0
Open

website/integrations: added hoarder integration #12161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions website/integrations/services/hoarder/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: Integrate with Hoarder
sidebar_label: Hoarder
---

# Hoarder

<span class="badge badge--secondary">Support level: Community</span>

## What is Hoarder

> A self-hostable bookmark-everything app (links, notes and images) with AI-based automatic tagging and full text search
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

>
> -- https://hoarder.app/

## Preparation

The following placeholders will be used:

- `hoarder.company` is the FQDN of the hoarder install.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `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

**Provider Settings**

In authentik under **Providers**, create an OAuth2/OpenID Provider with these settings:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


- 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should tell the user where the provider tab is and how to create one


## Hoarder configuration

In hoarder you'll need to add these environment variables:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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
OAUTH_CLIENT_ID=client_id_from_provider
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
OAUTH_CLIENT_ID=client_id_from_provider
OAUTH_CLIENT_ID=<Client ID from authentik>

OAUTH_CLIENT_SECRET=client_secret_from_provider
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
OAUTH_CLIENT_SECRET=client_secret_from_provider
OAUTH_CLIENT_SECRET=<Client secret from authentik>

OAUTH_WELLKNOWN_URL=https://authentik.company/application/o/hoarder/.well-known/openid-configuration
OAUTH_PROVIDER_NAME=Authentik
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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
# Optional but highly recommended:
# DISABLE_SIGNUPS=true
```

Finally, restart the hoarder server and test your configuration.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Finally, restart the hoarder server and test your configuration.
Finally, restart the Hoarder server and test your configuration.

1 change: 1 addition & 0 deletions website/sidebarsIntegrations.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ module.exports = {
"services/sonarr/index",
"services/tautulli/index",
"services/weblate/index",
"services/hoarder/index",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I'm not mistaken, services in the sidebar should be sorted alphabetically.

],
},
{
Expand Down