nextcloud / nextcloud/integration_paperless

Feature request: OpenID Connect authentication

Open
#22 0 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
PHP
Stars
38
Forks
8
Avg merge
1d 5h
Merged PRs (30d)
3

Description

Paperless-ngx supports OpenID-Connect authentication.
In conjunction with the Nextcloud plugin OIDC Identity Provider the setup is quite simple:

  1. Install and enable Nextcloud plugin OIDC Identity Provider
  2. Add new OpenID Connect-Client in https://nextcloud.example.com/settings/admin/security
    1. Name = Paperless-ngx
    2. Redirect-URI = https://paperless.example.com
    3. Copy ClientID and secret
  3. In the Paperless-ngx docker-compose.yml add environmnet variables for service webservice:
PAPERLESS_APPS: "allauth.socialaccount.providers.openid_connect"
PAPERLESS_SOCIALACCOUNT_PROVIDERS: '{"openid_connect": {"APPS": [{"provider_id": "nextcloud","name": "Nextcloud","client_id": "<Nextcloud client ID>","secret": "<Nextcloud client secret>","settings": { "server_url": "https://nextcloud.example.com"}}]}}'
PAPERLESS_DISABLE_REGULAR_LOGIN: true

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.

Research direction

Start with the repository's integration entry points and the Paperless-ngx webservice configuration in docker-compose.yml. Review how authentication is currently connected, then verify the supplied OpenID Connect settings against a Nextcloud OIDC Identity Provider. Done means the integration supports the described login flow and the documented environment variables work as shown.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker-compose, php
Domain
authentication
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.