Please add the callback URL to OpenID connect docs

Open Beginner friendly
#2,914 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Domain
authentication, documentation

Research direction

Start by locating the OpenID Connect documentation and the existing provider configuration instructions. Add the documented callback URL, using the shown docspell hostname and provider-id placeholders, and verify that the resulting instructions clearly identify the redirect destination.

Written by the indexing model from the issue text.

Description

documentation

I just set up an OIDC IDP with pocket-id that docspell can use to authenticate, and one thing that had me scratching my head at first was that there's no mention of the "final" URL on the docspell side that the authentication process will redirect to.

While it can be discovered with browser devtools or by reading the source code, I think it's better to just mention it: It's https://<docspell-base-hostname>/api/v1/open/auth/openid/<provider-id>/resume (:

Would you mind adding that to the documentation?

Dominant language
Elm
Stars
2.3k
Forks
184
Avg merge
7h 55m
Merged PRs (30d)
6

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from eikek/docspell

All issues in eikek/docspell

Similar issues

More Security issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.