plugin-oauth2

Halo 2.0 的 OAuth2 第三方登录插件。

使用方法

1. 在 Releases 下载最新的 JAR 文件。
2. 在 Halo 后台的插件管理上传 JAR 文件进行安装。
3. 进入 Console 端的用户管理，点击右上角的 认证方式 按钮进入认证方式管理列表即可看到当前插件提供的认证方式。
4. 按照下方的配置指南配置所需的认证方式并启用。
5. 进入当前登录用户的个人资料页面，即可绑定已启用的认证方式。

配置指南

目前支持的认证方式：

服务商	文档	Halo 所需配置	Scope	回调地址
GitHub	https://docs.github.com	Client ID Client Secret	无需手动设置	<SITE_URL>/login/oauth2/code/github
GitLab	https://docs.gitlab.com	Client ID Client Secret	read_user	<SITE_URL>/login/oauth2/code/gitlab
Gitee	https://gitee.com/oauth/applications	Client ID Client Secret	user_info	<SITE_URL>/login/oauth2/code/gitee

注意事项：

1. 如果认证失败，回调地址请使用 http 尝试。
2. <SITE_URL> 是不包含 console 的。
3. 如果你用于部署的服务器无法访问 GitHub，那 GitHub 认证会失败，其它同理，请先确认连通性。请尝试配置代理。

代理配置（可选）

如果你部署的 Halo 服务器无法直接访问 GitHub、GitLab 或 Gitee 的 API，你可以配置代理。

配置路径示例：${Halo 工作目录}/plugins/configs/plugin-oauth2.yaml。配置示例如下所示：

oauth2:
  proxy:
    enabled: true # 是否启用代理
    host: "host.halo.run" # 代理服务器主机名
    port: 6666 # 代理服务器端口
    username: "proxy-username" # 代理服务器用户名（可选）
    password: "proxy-password"  # 代理服务器密码（可选）
    connect-timeout-millis: 10000 # 连接超时时间，单位：毫秒（可选）

开发环境

插件开发的详细文档请查阅：https://docs.halo.run/developer-guide/plugin/hello-world

git clone [email protected]:halo-sigs/plugin-oauth2.git

# 或者当你 fork 之后

git clone [email protected]:{your_github_id}/plugin-oauth2.git

cd path/to/plugin-oauth2

# macOS / Linux
./gradlew build

# Windows
./gradlew.bat build

修改 Halo 配置文件：

halo:
  plugin:
    runtime-mode: development
    fixedPluginPath:
      - "/path/to/plugin-oauth2"