Skip to content

docs(sso): add Keycloak tutorial and split sso.md files#292

Open
dezhishen wants to merge 5 commits intoOpenListTeam:mainfrom
dezhishen:feat/keycloak
Open

docs(sso): add Keycloak tutorial and split sso.md files#292
dezhishen wants to merge 5 commits intoOpenListTeam:mainfrom
dezhishen:feat/keycloak

Conversation

@dezhishen
Copy link
Member

@dezhishen dezhishen commented Jan 22, 2026

Description / 描述

Motivation and Context / 背景

Closes #118

Relates to #XXXX

Checklist / 检查清单

  • I have read the CONTRIBUTING document.
    我已阅读 CONTRIBUTING 文档。
  • I have formatted my code or documentation with prettier or other appropriate formatter.
    我已使用 prettier 或其他适当的格式化工具格式化提交的代码或文档。
  • I have updated all supported languages (including Chinese and English) for documentation. (If it's needed)
    我已为所有支持语言(包括中文和英文)更新文档内容。 (若适用)
  • I have verified that the written documentation or code is properly formatted, with no syntax errors, spelling mistakes.
    我已确认编写的文档或代码格式正确, 无语法错误, 拼写错误。
  • I have updated the repository accordingly (If it's needed).
    我已相应更新了相关仓库(若适用)。

@dezhishen dezhishen requested a review from jyxjjj January 22, 2026 09:15
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request adds a Keycloak SSO tutorial and refactors the SSO documentation by splitting the monolithic sso.md file into separate, more maintainable files for each SSO provider.

Changes:

  • Added comprehensive Keycloak integration tutorial (07-keycloak.md) with step-by-step instructions in both English and Chinese
  • Split existing SSO documentation into separate files (01-GitHub.md through 06-Authentik.md)
  • Updated main sso.md to use markdown includes for the split files
  • Added three new screenshot images for the Keycloak tutorial

Reviewed changes

Copilot reviewed 8 out of 11 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
pages/guide/advanced/sso.md Refactored to use includes for SSO provider sections, maintaining the same content structure
pages/guide/advanced/sso/01-GitHub.md Extracted GitHub SSO tutorial from main file
pages/guide/advanced/sso/02-Dingtalk.md Extracted Dingtalk SSO tutorial from main file
pages/guide/advanced/sso/03-Microsoft.md Extracted Microsoft SSO tutorial from main file
pages/guide/advanced/sso/04-Google.md Extracted Google SSO tutorial from main file
pages/guide/advanced/sso/05-Casdoor.md Extracted Casdoor SSO tutorial from main file
pages/guide/advanced/sso/06-Authentik.md Extracted Authentik SSO tutorial from main file
pages/guide/advanced/sso/07-keycloak.md New comprehensive Keycloak SSO integration guide with bilingual instructions
public/img/advanced/sso/keycloak-01.png Screenshot for Keycloak general settings
public/img/advanced/sso/keycloak-02.png Screenshot for Keycloak capability configuration
public/img/advanced/sso/keycloak-03.png Screenshot for Keycloak login settings

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

jyxjjj and others added 3 commits February 2, 2026 11:22
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: ShenLin <773933146@qq.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: ShenLin <773933146@qq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FR] 接入OIDC添加KeyCloak文档

2 participants