如何在Zulip的docker-compose中配置GithubAuthBackend对接自建GitHub

1. 在自建GitHub创建OAuth应用 #

• 登录你的自建GitHub（GitHub.company.com），进入Settings > Developer settings > OAuth Apps，点击New OAuth App
• 填写应用信息：
  • Application name：自定义名称（比如Zulip Auth）
  • Homepage URL：你的Zulip服务访问地址（比如https://zulip.company.com）
  • Authorization callback URL：https://zulip.company.com/auth/github/complete/（必须和Zulip的访问地址严格匹配）
• 创建完成后，记录生成的Client ID和Client Secret

2. 修改Zulip的Docker环境配置 #

找到Zulip部署目录下的zulip.env文件，添加或修改以下环境变量：

# GitHub OAuth凭证
SOCIAL_AUTH_GITHUB_KEY=你的Client ID
SOCIAL_AUTH_GITHUB_SECRET=你的Client Secret

# 自建GitHub的API和基础地址
SOCIAL_AUTH_GITHUB_API_URL=https://github.company.com/api/v3/
SOCIAL_AUTH_GITHUB_BASE_URL=https://github.company.com/

# 确保认证后端包含GitHub Auth
AUTHENTICATION_BACKENDS=social_core.backends.github.GithubAuthBackend,zulip.backends.ZulipDummyBackend

注意：如果原来的AUTHENTICATION_BACKENDS已有其他后端，只需在列表中添加social_core.backends.github.GithubAuthBackend并用逗号分隔即可

3. 重启Zulip服务 #

在Zulip部署目录下执行命令重启容器：

docker-compose up -d

4. 验证配置 #

• 访问你的Zulip登录页面，检查是否出现Login with GitHub选项
• 点击该选项，跳转到自建GitHub授权页面，完成授权后确认是否能正常登录Zulip

常见注意事项 #

• 确保Zulip容器能正常访问自建GitHub的域名（GitHub.company.com），内网部署需提前打通网络连通性
• 自建GitHub的OAuth应用需开启read:user权限，确保能获取用户基本信息
• 如果登录时出现API错误，检查SOCIAL_AUTH_GITHUB_API_URL是否正确（必须以/api/v3/结尾）

内容的提问来源于stack exchange，提问作者Mohammad Saad