跳到主要内容
版本：开发版本 🚧

第三方登录

Zealot 支持使用已经支持的第三方服务授权登录，当前可以通过如下的环境变量或者在管理员面板的设置页面配置。

第三方服务标识符
飞书feishu
Gitlabgitlab
Googlegoogle_oauth2
LDAPldap
OpenID Connectopenid_connect

如果以上服务需要设置回调地址的话请统一设置为：

https://zealot.example.com/users/auth/:provider/callback

其中 :provider 是上面支持第三方服务的标识符，例如开启飞书那就把 :provider 替换成 feishu。

飞书​

  1. 去注册一个飞书账号并下载手机 App
  2. 注册飞书开发平台并创建企业自建应用获得 app_id, app_secret
  3. 填写 callback url 为 https://zealot.example.com/users/auth/feishu/callback (域名根据实际情况修改）
  4. 添加用户字段信息授权：email 地址 （可选）
  5. 至少勾选一个应用方式并创建新版本后发布
FEISHU_ENABLED=true
FEISHU_APP_ID=
FEISHU_APP_SECRET=

Gitlab​

  1. 注册 Gitlab 官方账户或自部署 Gitlab 服务
  2. 在用户设置（Preferences） -> 应用（Applications） 创建一个新应用
  3. 回调地址（Redirect URI） 配置为 https://zealot.example.com/users/auth/gitlab/callback (域名根据实际情况修改）
  4. 添加用户字段信息授权（scope）：read_user，默认 zealot 仅用此授权，如果你的授权范围是 api 也没问题
GITLAB_ENABLED=true
GITLAB_SITE=https://gitlab.com/api/v4
GITLAB_SCOPE=read_user
GITLAB_APP_ID=
GITLAB_SECRET=

Google​

  1. 注册 Google 账号
  2. 开通 Google Cloud Platform 服务
  3. 选择或创建 Project 并前往 Credentials
  4. 创建 OAuth Client ID 选择 Web Application 后添加回调地址（Authorized redirect URI） 配置为 https://zealot.example.com/users/auth/google_oauth2/callback (域名根据实际情况修改）
  5. 创建成功后获得 Client ID 和 Client Secret
GOOGLE_OAUTH_ENABLED=true
GOOGLE_CLIENT_ID=
GOOGLE_SECRET=

LDAP​

  1. 自部署或使用现有的 LDAP 服务
  2. 自配置或查找如下参数的值
LDAP_ENABLED=true
LDAP_HOST=10.0.0.1
LDAP_PORT=389
LDAP_METHOD=plain
LDAP_BIND_DN="cn=Manager,dc=example,dc=com"
LDAP_PASSWORD=password
LDAP_BASE="ou=People,dc=example,dc=com"
LDAP_UID=uid

OpenID Connect​

支持开启自动发现模式和手动设置两种方式

自动发现​

开启自动发现模式会自动获取 [OIDC_ISSUER_URL]/.well-known/openid-configuration 配置。

OIDC_ENABLED=true
OIDC_NAME=OIDC Provider
OIDC_CLIENT_ID=
OIDC_CLIENT_SECRET=
OIDC_SCOPE=openid,email,profile
OIDC_RESPONSE_TYPE=code
OIDC_UID_FIELD=preferred_username
OIDC_ISSUER_URL=https://oidc.example.com
OIDC_DISCOVERY=true

手动配置​

OIDC_ENABLED=true
OIDC_NAME=OIDC Provider
OIDC_CLIENT_ID=
OIDC_CLIENT_SECRET=
OIDC_SCOPE=openid,email,profile
OIDC_RESPONSE_TYPE=code
OIDC_UID_FIELD=preferred_username
OIDC_ISSUER_URL=https://oidc.example.com
OIDC_AUTH_URI=/authorize
OIDC_TOKEN_URI=/token
OIDC_USERINFO_URI=/userinfo

以上 OIDC_AUTH_URI，OIDC_TOKEN_URI，OIDC_USERINFO_URI 未设置时会使用如上的默认路径。