papermerge / documentation

Documentation for Papermerge DMS - Installation, Help, User Manual, REST API
https://docs.papermerge.io
Apache License 2.0
14 stars 5 forks source link

OIDC Documentation #103

Closed aevans1987 closed 8 months ago

aevans1987 commented 8 months ago

It has been a month since OIDC has been added to the software, can we please get documentation for how to do this? Even just the basics would be helpful, what are the Env vars?

ciur commented 8 months ago

Yes, OIDC is part of the 3.0 codebase, but never properly tested and actually I found some bugs which rendered the OIDC utterly useless.

However, as part of next release (3.1.0) I tested and fixed the OIDC part. In other words, OIDC (together with LDAP auth support) will be officially released, with proper documentation in next release - 3.1.0

I am updating the docs:

Notice though that docs are for 3.1, which in documentation is displayed as "3.1dev", which means "work in progress". Again, in 3.0 documentation you won't find any mention of OIDC/OAuth as code for OIDC in that release is buggy to the point where OIDC is unusable.

aevans1987 commented 8 months ago

So am i right in thinking that you aren't supporting any OAuth/OIDC that isn't Google or Github? What about things like Authentik or Keycloak and other self hosted options? Why is it being limited to Cloud platforms?

ciur commented 8 months ago

Yes, for 3.1 there will be only support for Google/GitHub cloud providers. But I don't see any difficultly in extending solution to any OIDC provider or even make it generic. Code for authentication backends is here

I will check both Authentik and Keycloak and try to add integration with these Identity providers.