InvenTree icon indicating copy to clipboard operation
InvenTree copied to clipboard

Add/Update documentation for SSO

Open SetZero opened this issue 3 months ago • 6 comments

Body of the issue

I tried to set-up SSO on my InvenTree instance and ran into a couple of issues while getting it to work. The current documentation for InvenTree's SSO seems to be outdated and/or confusing:

  • It mentions a "Add Social Applications" page which don't seem to exist anymore or is at a completly different location now. The example image social_account_add.png doesn't have the mentioned "Add Social Application" in it either.
  • From what it looks like the config.yaml is currently the only option to add a SSO provider. But maybe that's related to #4715 as this is still open?

If you could confirm these points I'd also be willing to help updating the documentation.

SetZero avatar Sep 27 '25 22:09 SetZero

@SetZero thanks for raising this. The documentation clearly needs work.

The image you linked is wrong - it should be pointing to the django admin section:

Image

Currently SSO applications must be created via the django admin panel - they are not available via the API.

If you would like to assist in improving the documentation around this, it would be greatly appreciated!

SchrodingersGat avatar Sep 28 '25 03:09 SchrodingersGat

@SchrodingersGat

After the update I am not able to navigate to the /admin as it redirects, was not able to locate social accounts settings page, can you help please?

nharmer1309 avatar Sep 28 '25 12:09 nharmer1309

@nharmer1309 depending on your setup you might need another slash, so /admin/

matmair avatar Sep 28 '25 14:09 matmair

@SetZero are you still willing to help us out with some documentation improvements here?

SchrodingersGat avatar Oct 07 '25 11:10 SchrodingersGat

@SchrodingersGat I will probably only get to do it next weekend, if that's not an issue

SetZero avatar Oct 07 '25 19:10 SetZero

That's great, thanks!

SchrodingersGat avatar Oct 07 '25 21:10 SchrodingersGat

Is the django admin panel disabled somehow or need to be enabled explicitly? thanks

barrowkwan avatar Nov 22 '25 06:11 barrowkwan

I have enabled the admin interface with INVENTREE_ADMIN_ENABLED but access /admin keep redirect to the '/web' and bring me back to the homepage. This happened since 1.x

barrowkwan avatar Nov 22 '25 07:11 barrowkwan

@barrowkwan you'll need the trailing slash i.e. /admin/ not /admin

SchrodingersGat avatar Nov 22 '25 07:11 SchrodingersGat

@SchrodingersGat thanks that works! so SSO can't configure with config.yaml but through django admin panel right?

barrowkwan avatar Nov 22 '25 07:11 barrowkwan