Project

General

Profile

Actions

Feature #30174

open

Improve SSO docs

Added by Chris Hofstaedtler over 4 years ago. Updated over 4 years ago.

Status:
New
Priority:
Normal
Assignee:
Category:
Authentication
Target version:
-
Difficulty:
Triaged:
No
Fixed in Releases:
Found in Releases:

Description

The current SSO docs fall short in many ways:

The Manual calls it "External Authentication", but in the source everything appears to be called SSO. This makes finding the docs harder than necessary.

The manual for External Authentication is written in a style of multiple concatenated tutorials. It does not seem to clearly explain which options for SSO exist, which assumptions Foreman makes for each SSO option, or the detailed configuration settings for them.
Generally it seems to follow a "Do X, Y, Z, and then magic happens" pattern. This makes the documentation very hard to consume, especially when trying to do something different from the tutorials (ex: integrating a different SSO source, which might be compatible with existing support in Foreman).

Section "5.7.5 Populate users and attributes" appears to have formatting issues. Also it somewhat shows which REMOTE_xxx variables Foreman understands, but with no explanation whatsoever.

IMO, the docs for SSO should explain:
- Which technologies Foreman supports for external auth
- Which settings are available for each (not just "in the installer, its this parameter")
- Known good providers

Thanks!

Actions

Also available in: Atom PDF