本指南将引导你以企业管理员身份设置、配置和管理 你的 GitHub Enterprise Server 实例。
GitHub 提供了两种部署 GitHub Enterprise 的方法。
- GitHub Enterprise Cloud
- GitHub Enterprise Server
GitHub 托管 GitHub Enterprise Cloud。 可以在自己的数据中心或受支持的云提供商中部署和托管 GitHub Enterprise Server 。
有关 GitHub Enterprise Server 的更多信息,请参阅“关于 GitHub Enterprise Server”。
第 1 部分:安装 GitHub Enterprise Server
要开始使用 GitHub Enterprise Server,你需要创建企业帐户、安装实例、使用 管理控制台 进行初始设置、配置实例和管理帐单。
1. 创建企业帐户
在安装 GitHub Enterprise Server 之前,可以通过联系 GitHub 的销售团队在 GitHub.com 上创建一个企业帐户。 GitHub.com 上的企业帐户可用于计费以及通过 GitHub Connect 与 GitHub.com 共享功能。 有关详细信息,请参阅“关于企业帐户”。
2. 安装 GitHub Enterprise Server
要开始使用 GitHub Enterprise Server,您需要在所选的虚拟化平台上安装设备。 有关详细信息,请参阅“设置 GitHub Enterprise Server 实例”。
3. 使用 管理控制台
你将使用 管理控制台 在首次启动 你的 GitHub Enterprise Server 实例 时完成初始设置过程。 还可以使用 管理控制台 管理实例设置,例如许可证、域、身份验证和 TLS。 有关详细信息,请参阅“从 Web UI 管理实例”。
4. 配置 你的 GitHub Enterprise Server 实例
除了 管理控制台 之外,还可以使用站点管理仪表板和管理 shell (SSH) 来管理 你的 GitHub Enterprise Server 实例。 例如,您可以配置应用程序和速率限制、查看报告、使用命令行实用程序。 有关详细信息,请参阅“配置 GitHub Enterprise”。
您可以使用 GitHub Enterprise Server 通过动态主机配置协议 (DHCP) 使用的默认网络设置,也可以使用虚拟机控制台配置网络设置。 您还可以配置代理服务器或防火墙规则。 有关详细信息,请参阅“配置网络设置”。
5. 配置高可用性
可以配置 你的 GitHub Enterprise Server 实例 来实现高可用性,以最大程度地减少硬件故障和网络中断的影响。 有关详细信息,请参阅“配置高可用性”。
6. 设置暂存实例
可以设置暂存实例来测试修改、规划灾难恢复,并在将更新应用于 你的 GitHub Enterprise Server 实例 之前试用更新。 有关详细信息,请参阅“设置暂存实例”。
7. 指定备份和灾难恢复
要保护生产数据,可以使用 GitHub Enterprise Server Backup Utilities 配置 你的 GitHub Enterprise Server 实例 的自动备份。 有关详细信息,请参阅“在实例上配置备份”。
8. 管理企业的账单
对于连接到你的企业帐户的所有组织和 GitHub Enterprise Server 实例,帐单将汇总到所有付费 GitHub.com 服务的单个帐单费用中。 企业所有者和帐单管理员均可访问和管理企业帐户的帐单设置。 有关详细信息,请参阅“关于企业的计费”。
第 2 部分:组织和管理团队
作为企业所有者或管理员,您可以管理用户、存储库、团队和组织级别的设置。 您可以管理企业成员、创建和管理组织、设置存储库管理策略以及创建和管理团队。
1. 管理 你的 GitHub Enterprise Server 实例 的成员
你可以管理 你的 GitHub Enterprise Server 实例 成员的设置和审核活动。 你可以将企业成员 提升为站点管理员、管理休眠用户、查看用户活动的审核日志以及自定义企业成员将看到的消息。 有关详细信息,请参阅“管理企业中的用户”。
2. 创建组织
可以在 你的 GitHub Enterprise Server 实例 中创建新组织以反映公司或组的结构。 有关详细信息,请参阅“从头开始创建新组织”。
3. 向组织添加成员
只要是要管理的组织中的组织所有者,就可以将成员添加到 你的 GitHub Enterprise Server 实例 中的组织。 还可以配置组织成员身份的可见性。 有关详细信息,请参阅“将人员添加到您的组织”和“配置组织成员关系的可见性”。
4. 创建团队
团队是可通过组形式向其授予特定存储库权限的组织成员组。 可以在每个组织中创建单个团队或多个级别的嵌套团队。 有关详细信息,请参阅“创建团队”和“添加组织成员到团队”。
5. 设置组织和存储库权限级别
我们建议为每个组织中的有限成员提供组织所有者角色,该角色为该组织提供完整的管理访问权限。 有关详细信息,请参阅“组织中的角色”。
对于你拥有管理员权限的组织,你还可以使用精细的权限级别自定义对每个存储库的访问权限。 有关详细信息,请参阅“组织的存储库角色”。
6. 实施存储库管理策略
作为企业所有者,你可以在 你的 GitHub Enterprise Server 实例 中为所有组织设置存储库管理策略,或者允许在每个组织中单独设置策略。 有关详细信息,请参阅“在企业中实施仓库管理策略”。
第 3 部分:安全构建
要提高 你的 GitHub Enterprise Server 实例 的安全性,可以为企业成员配置身份验证,使用工具和审核日志记录以保持合规性,为组织配置安全性和分析功能,以及选择性地启用 GitHub Advanced Security。
1. 对企业成员进行身份验证
可以使用 GitHub Enterprise Server 的内置身份验证方法,也可以在外部身份验证提供程序(如 CAS、LDAP 或 SAML)之间进行选择,以集成现有帐户并集中管理用户对 你的 GitHub Enterprise Server 实例 的访问。 有关详细信息,请参阅“关于身份和访问管理”。
您还可以要求对每个组织进行双重身份验证。 有关详细信息,请参阅“为组织要求双重身份验证”。
2. 保持合规性
您可以实施所需的状态检查和提交验证,以强制实施组织的合规性标准并自动执行合规性工作流。 您还可以使用组织的审核日志来查看团队执行的操作。 有关详细信息,请参阅“使用预接收挂钩实施策略”和“关于企业的审核日志”。
3. 为组织配置安全功能
为了确保你的 GitHub Enterprise Server 实例中的组织安全,你可以使用各种GitHub安全功能,包括安全策略、依赖项关系图、机密扫描以及 Dependabot 安全和版本更新。 有关详细信息,请参阅“保护你的组织”和“管理组织的安全和分析设置”。
4. 启用 GitHub Advanced Security 功能
您可以升级 GitHub Enterprise Server 许可证以包含 GitHub Advanced Security。 这将提供额外的功能,帮助用户发现和修复其代码中的安全问题,例如代码和机密扫描。 有关详细信息,请参阅“为企业启用 GitHub 高级安全性”。
第 4 部分:自定义和自动化企业在 GitHub 上的工作
您可以使用 GitHub 和 OAuth apps、GitHub Enterprise Server API、GitHub Actions、GitHub Packages 和 GitHub Pages 自定义和自动化企业中组织中的工作。
1. 构建 GitHub Apps 和 OAuth apps
您可以构建与 GitHub Enterprise Server API 的集成,如 GitHub Apps 或 OAuth apps,以便在企业中的组织中使用,以补充和扩展您的工作流程。 有关详细信息,请参阅“关于创建 GitHub 应用”。
2. 使用 GitHub Enterprise Server API
GitHub Enterprise Server API 有两个版本:REST API 和 GraphQL API。 要自动执行常见任务、备份数据或创建集成,可以使用 GitHub Enterprise Server API。 有关详细信息,请参阅“比较 GitHub 的 REST API 和 GraphQL API”。
3. 生成 GitHub Actions
使用 GitHub Actions,可以在 GitHub Enterprise Server 上自动执行和自定义 你的 GitHub Enterprise Server 实例 的开发工作流。 您可以创建自己的操作,以及使用和自定义 GitHub 社区分享的操作。 有关详细信息,请参阅“了解 GitHub Actions”。
有关如何在 GitHub Enterprise Server 上配置 GitHub Actions 的详细信息,请参阅“GitHub Actions for GitHub Enterprise Server 使用入门”。
4. 发布和管理 GitHub Packages
GitHub Packages 是一种软件包托管服务,允许您私下或公开托管软件包,并将包用作项目中的依赖项。 有关详细信息,请参阅“GitHub Packages 简介”。
有关启用和配置 你的 GitHub Enterprise Server 实例 的 GitHub Packages 的详细信息,请参阅“企业 GitHub Packages 使用入门”。
5. 使用 GitHub Pages
GitHub Pages 是一项静态站点托管服务,它直接从存储库获取 HTML、CSS 和 JavaScript 文件并发布网站。 可以在组织级别为企业成员启用或禁用 GitHub Pages。 有关详细信息,请参阅“为企业配置 GitHub Pages”和“关于 GitHub Pages”。
第 5 部分:与其他 GitHub 资源连接
您可以使用 GitHub Connect 共享资源。
如果您既是 GitHub Enterprise Server 实例的所有者,又是 GitHub Enterprise Cloud 组织或企业帐户的所有者,则可以启用 GitHub Connect。 GitHub Connect 允许你在 你的 GitHub Enterprise Server 实例 和 GitHub Enterprise Cloud 之间共享特定的工作流和功能,例如统一搜索和贡献。 有关详细信息,请参阅“管理 GitHub Connect”。
第 6 部分:使用 GitHub 的学习和支持资源
企业成员可以通过我们的学习资源了解有关 Git 和 GitHub 的更多信息,并且你可以在设置和管理 你的 GitHub Enterprise Server 实例 时向 GitHub Enterprise 支持获得所需的支持。
1. 在 GitHub Docs
上阅读 GitHub Enterprise Server
您可以阅读反映 GitHub Enterprise Server 可用功能的文档。 有关详细信息,请参阅“关于 GitHub 文档的版本”。
若要了解企业如何最有效地使用 GitHub Enterprise Server,请参阅“企业最佳做法”。
2. 通过 GitHub Skills
学习
企业成员可以通过 GitHub Skills 在自己的 GitHub 存储库中完成有趣、逼真的项目来学习新技能。 每门课程都是由 GitHub 社区创建并由友好的机器人教授的实践课程。
有关详细信息,请参阅“Git 和 GitHub 学习资源”。
3. 使用 GitHub Enterprise 支持
GitHub Enterprise Server 包括对 GitHub Enterprise 支持 的访问权限。 GitHub Enterprise 支持 可帮助排除 GitHub Enterprise Server 上出现的问题。 你还可以选择注册 GitHub 高级支持以获取更多功能。 有关详细信息,请参阅“关于 GitHub 支持”。