owncloud
Improve OpenID connect docs
WHAT Needs to be Documented?
A user has reported that it is hard to find how to configure the openidconnect app to use a certain attribute as the userid. The readme of the readme of the oidc app repo is mentioning some details in step 9) https://github.com/owncloud/openidconnect/#how-to-setup-an-idp-for-development-and-test-purpose
There are some more details missing in the official docs that are present in the readme e.g. https://github.com/owncloud/openidconnect/#all-configuration-values-explained
WHERE Does This Need To Be Documented (Link)?
https://doc.owncloud.com/server/next/admin_manual/configuration/user/oidc/oidc.html
WHY Should This Change Be Made?
Because its missing on the docs website and hard to find.
(Optional) What Type Of Content Change Is This?
- [X] New Content Addition
- [ ] Old Content Deprecation
- [ ] Existing Content Simplification
- [ ] Bug Fix to Existing Content
(Optional) Which Manual Does This Relate To?
- [X] Admin Manual
- [ ] Developer Manual
- [ ] User Manual
- [ ] Android
- [ ] iOS
- [ ] Branded Clients
- [ ] Desktop Client
- [ ] Other
There are some more details missing in the official docs that are present in the readme e.g.
I have made an 1:1 comparision of the keys
https://github.com/owncloud/openidconnect/#all-configuration-values-explained vs https://doc.owncloud.com/server/next/admin_manual/configuration/server/config_apps_sample_php_parameters.html#app-openid-connect-oidc
I have NOT found parameters missing - all of them which are present in the repo readme are available in the documentation. But I am open for a note what exactly is missing.
How to setup an IdP for development and test purpose
https://github.com/owncloud/openidconnect/#how-to-setup-an-idp-for-development-and-test-purpose and https://doc.owncloud.com/server/next/admin_manual/configuration/user/oidc/oidc.html
Such a description is definitely missing in the official oidc documentation. I propose an own document like we have with Example Setup Using Kopano Konnect. We can take the input of https://github.com/owncloud/openidconnect/#how-to-setup-an-idp-for-development-and-test-purpose as base.
@C0rby fyi
I have NOT found parameters missing - all of them which are present in the repo readme are available in the documentation. But I am open for a note what exactly is missing.
You just need to check the docs link I've posted... Im a stupid admin that does the following:
- go to doc.owncloud.com
- use the search to find "openid"
- take one of the first results, named "OpenID Connect (OIDC)"
- open it, be happy that this seems to be the admin docs for the OpenID connect setup (at least the URL indicates that I'm reading the admin docs right now)
That we have the Apps settings into another separate page was at least confusing to me, and I was not able to find it on a quick search, and I think that's how a lot of people using the docs.
@xoxys to be fair, lets separate the topics:
- The documentation of OIDC is incorrect, is missing stuff or needs partial improvements
- Searching inside our documentation - which we know is one of the steps we have to do
...the Apps settings into another separate page...
App settings differ depending on the provider you use. Atm we have Kopano and Azure but excpect more to come like KeyCloak or others, just see the test/dev env discussed above. Having all in one document makes this not readable anymore - so what is expected?
Please let discuss in this issue only (1) and for this I need - because I am not an exert in OIDC what exactly needs to be changed. We can have on tuesday a call to go into the details if you want.