Documentation Corrections and Enhancements

[paschulke]

Issue: Documentation Corrections and Enhancements

1. Incorrect Description for SOCIALACCOUNT_AUTO_SIGNUP

Under Authentication Documentation:

• Current Description:
  SOCIALACCOUNT_AUTO_SIGNUP = True forces new users to fill out a signup form even if the provider does provide the email address.

• Correct Description:
  SOCIALACCOUNT_AUTO_SIGNUP = False forces new users to fill out a signup form even if the provider does provide the email address.

2. Database Initialization Required After Setting OIDC

When choosing OIDC (e.g. Keycloak) as an IDP, the database initialization must be repeated after the allauth Library Installation as described in the Database Initialization Documentation.

3. Mentioning the LOGIN_FORM Parameter

Including a reference to the LOGIN_FORM parameter in the authentication documentation All Auth documentation would be helpful for clarity and completeness.

4. Additional Profile Parameters

The following parameters should also be mentioned in All Auth documentation to clarify their role:

PROFILE_UPDATE = False
PROFILE_DELETE = False

5. TLS Certificate for On-Premise IDP Deployments

For on-premise IDP deployments (e.g. Keycloak), adding the TLS IDP Certificate to Python Packages is necessary unless an alternative implementation is provided by the project maintainers.

• Example Command:

echo 'COMPANY CA
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----' | sudo tee -a /srv/rdmo/rdmo-app/env/lib/python*/site-packages/certifi/cacert.pem

Suggested Actions

1. Update the documentation for SOCIALACCOUNT_AUTO_SIGNUP to reflect the correct behavior.
2. Add a note under OIDC configuration to repeat the database initialization step.
3. Include references to the LOGIN_FORM, PROFILE_UPDATE, and PROFILE_DELETE parameters for better user guidance.
4. Provide instructions or a note about adding TLS certificates for on-premise IDP deployments.

Thank you for considering these updates!

[MyPyDavid]

thanks for the suggestions! I'll transfer this issue to our rdmo-docs repo.