ENG-8753 docs: add enterprise auth documentation section#6672
ENG-8753 docs: add enterprise auth documentation section#6672FarhanAliRaza wants to merge 7 commits into
Conversation
Add docs for the OIDC AuthPlugin covering the secure-by-default model, providers, custom auth pages, and testing guarded code. Register the new pages in the enterprise sidebar, add an Authentication category to the enterprise overview, and whitelist the section for preview.
Merging this PR will not alter performance
Comparing Footnotes
|
Greptile SummaryThis PR adds a complete enterprise authentication documentation section covering the
Confidence Score: 5/5Safe to merge — purely documentation additions and a minor cleanup of a commented-out line in whitelist.py. All changes are new markdown documentation files plus sidebar/overview wiring that follows the established enterprise page registration pattern exactly. The whitelist.py change removes a commented-out example and leaves the list empty, which is the correct state for building all pages. No functional Python logic is modified. No files require special attention. Important Files Changed
Reviews (5): Last reviewed commit: "docs(auth): refine compile-time, check-a..." | Re-trigger Greptile |
Document that User.name/.email/.sub/.picture resolve against AuthUserState — populated after login by whichever provider authenticated the user — so they work in single- and multi-provider setups alike, rather than the first configured provider. Correct their type from `str | None` to `str` (empty until login) and note AuthUserState.provider_name / User.current_provider() for branching on the active provider.
Add a new "Deploying to Production" page covering the HTTPS/Secure-cookie requirement, exact redirect URI construction, reverse-proxy origin handling, and a troubleshooting reference keyed on literal errors. Wire it into the enterprise sidebar, overview listing, and docs whitelist. Revise the existing auth pages (overview, secure-by-default, providers, custom-pages, testing) for accuracy and depth.
…m-pages Point the logout-flow descriptions at the secure-by-default section that documents the cross-site logout guard, so readers can find the guarantee from where logout is first mentioned.
Drop the auth-docs preview entries now that the section is complete; an empty whitelist builds the full site, matching upstream behavior.
Clarify that the app compiles before the IdP is reachable (discovery happens at login), that auth= checks attach to specific events/vars/ fields, and tighten the testing guide: run from tests/, the _userinfo/userinfo split, and a full Playwright OIDC end-to-end example.
Add docs for the OIDC AuthPlugin covering the secure-by-default model, providers, custom auth pages, and testing guarded code. Register the new pages in the enterprise sidebar, add an Authentication category to the enterprise overview, and whitelist the section for preview.
All Submissions:
Type of change
Please delete options that are not relevant.
New Feature Submission:
Changes To Core Features: