Skip to main content

此版本的 GitHub Enterprise 将停止服务 2022-06-03. 即使针对重大安全问题,也不会发布补丁。 要获得更好的性能、改进的安全性和新功能,请升级到 GitHub Enterprise 的最新版本。 如需升级方面的帮助,请联系 GitHub Enterprise 支持

Getting started with GitHub Enterprise Server

Get started with setting up and managing 您的 GitHub Enterprise Server 实例.

This guide will walk you through setting up, configuring and managing 您的 GitHub Enterprise Server 实例 as an enterprise administrator.

GitHub provides two ways to deploy GitHub Enterprise.

  • GitHub Enterprise Cloud
  • GitHub Enterprise Server

GitHub hosts GitHub Enterprise Cloud. You can deploy and host GitHub Enterprise Server in your own datacenter or a supported cloud provider.

For an overview of how GitHub Enterprise Server works, see "System overview."

Part 1: Installing GitHub Enterprise Server

To get started with GitHub Enterprise Server, you will need to create your enterprise account, install the instance, use the Management Console for initial setup, configure your instance, and manage billing.

1. Creating your enterprise account

Before you install GitHub Enterprise Server, you can create an enterprise account on GitHub.com by contacting GitHub's Sales team. An enterprise account on GitHub.com is useful for billing and for shared features with GitHub.com via GitHub Connect. For more information, see "About enterprise accounts."

2. Installing GitHub Enterprise Server

To get started with GitHub Enterprise Server, you will need to install the appliance on a virtualization platform of your choice. For more information, see "Setting up a GitHub Enterprise Server instance."

3. Using the Management Console

You will use the Management Console to walk through the initial setup process when first launching 您的 GitHub Enterprise Server 实例. You can also use the Management Console to manage instance settings such as the license, domain, authentication, and TLS. For more information, see "Accessing the management console."

4. Configuring 您的 GitHub Enterprise Server 实例

In addition to the Management Console, you can use the site admin dashboard and the administrative shell (SSH) to manage 您的 GitHub Enterprise Server 实例. For example, you can configure applications and rate limits, view reports, use command-line utilities. For more information, see "Configuring your enterprise."

You can use the default network settings used by GitHub Enterprise Server via the dynamic host configuration protocol (DHCP), or you can also configure the network settings using the virtual machine console. You can also configure a proxy server or firewall rules. For more information, see "Configuring network settings."

5. Configuring high availability

You can configure 您的 GitHub Enterprise Server 实例 for high availability to minimize the impact of hardware failures and network outages. For more information, see "Configuring high availability."

6. Setting up a staging instance

You can set up a staging instance to test modifications, plan for disaster recovery, and try out updates before applying them to 您的 GitHub Enterprise Server 实例. For more information, see "Setting up a staging instance."

7. Designating backups and disaster recovery

To protect your production data, you can configure automated backups of 您的 GitHub Enterprise Server 实例 with GitHub Enterprise Server 备份实用程序. For more information, see "Configuring backups on your appliance."

8. Managing billing for your enterprise

Billing for all the organizations and GitHub Enterprise Server instances connected to your enterprise account is aggregated into a single bill charge for all of your paid GitHub.com services. Enterprise owners and billing managers can access and manage billing settings for enterprise accounts. For more information, see "Managing billing for your enterprise."

Part 2: Organizing and managing your team

As an enterprise owner or administrator, you can manage settings on user, repository, team and organization levels. You can manage members of your enterprise, create and manage organizations, set policies for repository management, and create and manage teams.

1. Managing members of 您的 GitHub Enterprise Server 实例

您可以管理 您的 GitHub Enterprise Server 实例 的成员的设置和审核活动。 您可以将企业成员提升为站点管理员、管理休眠用户、查看用户活动的审核日志以及自定义企业成员将看到的消息。 更多信息请参阅“管理企业中的用户”。

2. Creating organizations

您可以在 您的 GitHub Enterprise Server 实例 中创建新组织,以反映您的公司或组的结构。 更多信息请参阅“从头开始创建新组织”。

3. Adding members to organizations

您可以向 您的 GitHub Enterprise Server 实例 中的组织添加成员,只要您是要管理的组织中的组织所有者即可。 您还可以配置组织成员身份的可见性。 更多信息请参阅“将人员添加到组织”和“配置组织成员身份的可见性”。

4. Creating teams

团队是组织成员的组,可以作为一个组被授予对特定存储库的权限。 您可以在每个组织中创建单个团队或多个级别的嵌套团队。 更多信息请参阅“创建团队”和“向团队添加人员”。

5. Setting organization and repository permission levels

我们建议为每个组织中有限数量的成员提供组织所有者角色,以便为该组织提供完全管理访问权限。 更多信息请参阅“组织中的角色”。

对于您具有管理员权限的组织,您还可以使用精细的权限级别自定义对每个存储库的访问权限。 更多信息请参阅“组织的仓库权限级别”。

6. Enforcing repository management policies

作为企业所有者,您可以为 您的 GitHub Enterprise Server 实例 中的所有组织设置存储库管理策略,或者允许在每个组织中单独设置策略。 更多信息请参阅“在企业中实施仓库管理策略”。

Part 3: Building securely

To increase the security of 您的 GitHub Enterprise Server 实例, you can configure authentication for enterprise members, use tools and audit logging to stay in compliance, configure security and analysis features for your organizations, and optionally enable GitHub Advanced Security.

1. Authenticating enterprise members

You can use GitHub Enterprise Server's built-in authentication method, or you can choose between an external authentication provider, such as CAS, LDAP, or SAML, to integrate your existing accounts and centrally manage user access to 您的 GitHub Enterprise Server 实例. For more information, see "About authentication for your enterprise."

You can also require two-factor authentication for each of your organizations. For more information, see "Requiring two factor authentication for an organization."

2. Staying in compliance

You can implement required status checks and commit verifications to enforce your organization's compliance standards and automate compliance workflows. You can also use the audit log for your organization to review actions performed by your team. For more information, see "Enforcing policy with pre-receive hooks" and "About the audit log for your enterprise."

3. Configuring security features for your organizations

为保持 您的 GitHub Enterprise Server 实例 中的组织 安全,您可以使用各种 GitHub 安全功能,包括安全策略、依赖关系图、秘密扫描以及 Dependabot 安全和版本更新。 更多信息请参阅“保护组织”和“管理组织的安全和分析设置”。

4. Enabling GitHub Advanced Security features

You can upgrade your GitHub Enterprise Server license to include GitHub Advanced Security. This provides extra features that help users find and fix security problems in their code, such as code and secret scanning. For more information, see "GitHub Advanced Security for your enterprise."

Part 4: Customizing and automating your enterprise's work on GitHub

You can customize and automate work in organizations in your enterprise with GitHub and OAuth 应用程序, GitHub Enterprise Server API, GitHub Actions, GitHub Packages , and GitHub Pages.

1. Building GitHub 应用程序 and OAuth 应用程序

You can build integrations with the GitHub Enterprise Server API, such as GitHub 应用程序 or OAuth 应用程序, for use in organizations in your enterprise to complement and extend your workflows. For more information, see "About apps."

2. Using the GitHub Enterprise Server API

There are two versions of the GitHub Enterprise Server API: the REST API and the GraphQL API. You can use the GitHub Enterprise Server APIs to automate common tasks, back up your data, or create integrations that extend GitHub Enterprise Server. For more information, see "About GitHub's APIs."

3. Building GitHub Actions

With GitHub Actions, you can automate and customize 您的 GitHub Enterprise Server 实例's development workflow on GitHub Enterprise Server. You can create your own actions, and use and customize actions shared by the GitHub community. For more information, see "Learn GitHub Actions."

For more information on enabling and configuring GitHub Actions on GitHub Enterprise Server, see "Getting started with GitHub Actions for GitHub Enterprise Server."

4. Publishing and managing GitHub Packages

GitHub Packages 是一种软件包托管服务,允许您私下或公开托管软件包,并将包用作项目中的依赖项。 更多信息请参阅“GitHub Packages 简介”。

For more information on enabling and configuring GitHub Packages for 您的 GitHub Enterprise Server 实例, see "Getting started with GitHub Packages for your enterprise."

5. Using GitHub Pages

GitHub Pages 是一个静态网站托管服务,它直接从存储库中获取 HTML、CSS 和 JavaScript 文件并发布网站。 您可以在组织级别为企业成员启用或禁用 GitHub Pages。 更多信息请参阅“为企业配置 GitHub Pages”和“关于 GitHub Pages”。

Part 5: Connecting with other GitHub resources

You can use GitHub Connect to share resources.

If you are the owner of both a GitHub Enterprise Server instance and a GitHub Enterprise Cloud organization or enterprise account, you can enable GitHub Connect. GitHub Connect allows you to share specific workflows and features between 您的 GitHub Enterprise Server 实例 and GitHub Enterprise Cloud, such as unified search and contributions. For more information, see "Connecting GitHub Enterprise Server to GitHub Enterprise Cloud."

Part 6: Using GitHub's learning and support resources

Your enterprise members can learn more about Git and GitHub with our learning resources, and you can get the support you need when setting up and managing 您的 GitHub Enterprise Server 实例 with GitHub Enterprise Support.

1. Reading about GitHub Enterprise Server on GitHub Docs

You can read documentation that reflects the features available with GitHub Enterprise Server. For more information, see "About versions of GitHub Docs."

2. Learning with GitHub Learning Lab

您的企业成员可以通过 GitHub Learning Lab 在自己的 GitHub 存储库中完成有趣、逼真的项目来学习新技能。 每门课程都是由 GitHub 社区创建的实践课程,由友好的学习实验室机器人授课。

更多信息请参阅“Git 和 GitHub 学习资源”。

3. Working with GitHub Enterprise Support

GitHub Enterprise Server 包括对 GitHub Enterprise 支持 的访问。 GitHub Enterprise 支持 可帮助您排除 GitHub Enterprise Server 上出现的问题。 您还可以选择注册 GitHub 高级支持以获取其他功能。 更多信息请参阅“关于 GitHub Enterprise 支持”。