本指南介绍如何从私有的 GitHub 存储库安装 Discourse 主题或主题组件。
所需用户级别:管理员
摘要
本文档介绍如何从私有的 GitHub 存储库安装 Discourse 主题或主题组件的过程。它包括生成和使用 SSH 密钥以实现安全访问的步骤。您需要对您的 Discourse 实例和要安装的 GitHub 存储库都具有管理员权限。这样您就可以在论坛上使用您自己的私有主题和主题组件。
先决条件
在开始之前,请确保您拥有:
- 对您的 Discourse 实例的管理员访问权限
- 包含您的主题或组件的私有 Git 存储库
- 访问权限以便向您的 Git 存储库添加部署密钥(管理员/所有者级别)
分步指南
- 前往您的私有 GitHub 存储库,并从“Clone SSH”标签页复制 SSH 地址。
2. 导航到您的 Discourse 管理面板。
3. 在管理侧边栏中,转到
Appearance > Themes and components,然后选择 Themes 或 Components 标签页(取决于您要安装的是主题还是组件)。4. 点击
Install,然后选择 From a git repository。
5. 粘贴您在第 1 步中从私有存储库复制的 SSH 地址。它的格式应为:
git@github.com:USERNAME/REPO-NAME.git。
确保使用 使用 SSH 克隆 的链接,而不是以
https开头的链接。
6. 一个 SSH 密钥将自动生成并显示在一个新的文本框中。
7. 点击该框右上角的复制图标以复制新的 SSH 密钥。在点击安装或关闭此模态框之前,请勿进行下一步。
8. 现在前往您的私有 GitHub 存储库设置(例如,在 GitHub 上,前往
Settings > Deploy keys)
9. 添加一个新的部署密钥。您需要为其指定一个合适的标题。将您从 Discourse 复制的 SSH 密钥粘贴到部署密钥字段中。
10. 点击
Add key 将部署密钥保存在您的 Git 存储库设置中。
11. 返回 Discourse 主题安装模态框并点击
Install 按钮。此时您应该会看到新的主题或组件设置页面。
最佳实践
- 始终使用存储库的 SSH URL,而不是 HTTPS URL。
- 保持您的部署密钥安全,不要公开分享。
- 定期更新您的主题或组件,以确保您拥有最新的功能和安全更新。
常见问题解答
问:我可以使用此方法与 GitHub 以外的 Git 提供商一起使用吗?
答:是的,此方法应适用于支持部署密钥或 SSH 身份验证的任何 Git 提供商。
问:Discourse 会记住 SSH 密钥以供将来更新使用吗?
答:是的,Discourse 将存储生成的私钥并将其用于将来访问 Git 存储库。
问:我以后可以更改私有存储库吗?
答:是的,如果需要,您可以在主题设置中更新存储库 URL。
附加资源
本主题中使用的 SSH 密钥仅为该文档生成*






