Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/halo-sigs/plugin-oauth2
Halo 2.0 的 OAuth2 第三方登录插件。
https://github.com/halo-sigs/plugin-oauth2
halo halo-plugin oauth2
Last synced: 3 days ago
JSON representation
Halo 2.0 的 OAuth2 第三方登录插件。
- Host: GitHub
- URL: https://github.com/halo-sigs/plugin-oauth2
- Owner: halo-sigs
- License: gpl-3.0
- Created: 2023-03-13T04:33:10.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-30T04:20:56.000Z (about 1 month ago)
- Last Synced: 2024-11-02T09:31:53.661Z (about 1 month ago)
- Topics: halo, halo-plugin, oauth2
- Language: Java
- Homepage: https://halo.run/store/apps/app-ESVDK
- Size: 2.68 MB
- Stars: 22
- Watchers: 2
- Forks: 24
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-halo - plugin-oauth2 - Halo 2.0 的 OAuth2 第三方登录插件 (Halo 2.0 / 插件)
README
# plugin-oauth2
Halo 2.0 的 OAuth2 第三方登录插件。
## 使用方法
1. 在 [Releases](https://github.com/halo-sigs/plugin-oauth2/releases) 下载最新的 JAR 文件。
2. 在 Halo 后台的插件管理上传 JAR 文件进行安装。
3. 进入 Console 端的用户管理，点击右上角的 `认证方式` 按钮进入认证方式管理列表即可看到当前插件提供的认证方式。
4. 按照下方的配置指南配置所需的认证方式并启用。
5. 进入当前登录用户的个人资料页面，即可绑定已启用的认证方式。
## 配置指南
目前支持的认证方式：
| 服务商 | 文档 | Halo 所需配置 | Scope | 回调地址 |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------- | ------------ | ------------------------------------- |
| GitHub | [https://docs.github.com](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) | `Client ID` `Client Secret` | 无需手动设置 | `/login/oauth2/code/github` |
| GitLab | [https://docs.gitlab.com](https://docs.gitlab.com/ee/integration/oauth_provider.html#configure-gitlab-as-an-oauth-20-authentication-identity-provider) | `Client ID` `Client Secret` | `read_user` | `/login/oauth2/code/gitlab` |
| Gitee | | `Client ID` `Client Secret` | `user_info` | `/login/oauth2/code/gitee` |
注意事项：
1. 如果认证失败，回调地址请使用 `http` 尝试。
2. 是不包含 `console` 的。
3. 如果你用于部署的服务器无法访问 GitHub，那 GitHub 认证会失败，其它同理，请先确认连通性。
## 开发环境
插件开发的详细文档请查阅：
```bash
git clone [email protected]:halo-sigs/plugin-oauth2.git
# 或者当你 fork 之后
git clone [email protected]:{your_github_id}/plugin-oauth2.git
```
```bash
cd path/to/plugin-oauth2
```
```bash
# macOS / Linux
./gradlew build
# Windows
./gradlew.bat build
```
修改 Halo 配置文件：
```yaml
halo:
plugin:
runtime-mode: development
fixedPluginPath:
- "/path/to/plugin-oauth2"
```