Skip to main content

Enabling GitHub Advanced Security for your enterprise

You can configure GitHub Enterprise Server to include GitHub Advanced Security. This provides extra features that help users find and fix security problems in their code.

GitHub Advanced Security は、GitHub Enterprise Cloud、GitHub Enterprise Server のエンタープライズ アカウントで利用できます。 GitHub Enterprise Server インスタンスの更新に関する詳細については、「新しいリリースへのアップグレードについて」を参照してください。また、現在のリリース バージョンからのアップグレード パスを確認するには、アップグレード アシスタント を参照してください。

About enabling GitHub Advanced Security

GitHub Advanced Securityは、開発者がコードのセキュリティ及び品質を改善し、維持するための役に立ちます。 詳細については、「GitHub Advanced Security について」を参照してください。

When you enable GitHub Advanced Security for your enterprise, repository administrators in all organizations can enable the features unless you set up a policy to restrict access. For more information, see "Enforcing policies for Advanced Security in your enterprise."

For guidance on a phased deployment of GitHub Advanced Security, see "Introduction to adopting GitHub Advanced Security at scale."

Checking whether your license includes GitHub Advanced Security

  1. GitHub Enterprise Server の右上で、ご自分のプロファイル写真をクリックしてから、 [Enterprise 設定] をクリックします。 GitHub Enterprise Server のプロファイル写真のドロップダウン メニューの [自分の Enterprise]

  2. エンタープライズ アカウントのサイドバーで、 [設定] をクリックします。 エンタープライズ アカウントのサイドバー内の [設定] タブ

  3. 左側のサイドバーで、 [ライセンス] をクリックします。 [Enterprise アカウント設定] サイドバーの [ライセンス] タブ

  4. If your license includes GitHub Advanced Security, the license page includes a section showing details of current usage. GitHub Advanced Security section of Enterprise license

Prerequisites for enabling GitHub Advanced Security

  1. Upgrade your license for GitHub Enterprise Server to include GitHub Advanced Security. For information about licensing, see "About billing for GitHub Advanced Security."

  2. Download the new license file. For more information, see "Downloading your license for GitHub Enterprise."

  3. Upload the new license file to your GitHub Enterprise Server instance. For more information, see "Uploading a new license to GitHub Enterprise Server."

  4. Review the prerequisites for the features you plan to enable.

Enabling and disabling GitHub Advanced Security features

警告: この設定を変更すると、GitHub Enterprise Server 上のユーザーが利用するサービスが再起動されます。 ユーザーのダウンタイムを最小限に抑えるために、この変更のタイミングは慎重に選ぶ必要があります。

  1. GitHub Enterprise Server の管理アカウントから、任意のページの右上隅の をクリックします。

    サイト管理者設定にアクセスするための宇宙船アイコンのスクリーンショット

  2. [サイト管理者] ページにまだ表示されていない場合は、左上隅の [サイト管理者] をクリックします。

    [サイト管理者] リンクのスクリーンショット

  3. 左側のサイドバーで、 [Management Console] をクリックします。 左側のサイドバーの [[Management Console]] タブ

  4. 左側のサイドバーで、[Security] (セキュリティ) をクリックします。 [Security](セキュリティ) サイドバー

  5. Under "Security," select the features that you want to enable and deselect any features you want to disable. Checkbox to enable or disable Advanced Security features

  6. 左側のサイドバーで、 [設定の保存] をクリックします。

    [Management Console] の [設定の保存] ボタンのスクリーンショット

    注: [Management Console] に設定を保存すると、システム サービスが再起動され、ユーザーに表示されるダウンタイムが発生する可能性があります。

  7. 設定の実行が完了するのを待ってください。

    インスタンスの設定

When GitHub Enterprise Server has finished restarting, you're ready to set up any additional resources required for newly enabled features. For more information, see "Configuring code scanning for your appliance."

Enabling or disabling GitHub Advanced Security features via the administrative shell (SSH)

You can enable or disable features programmatically on your GitHub Enterprise Server instance. For more information about the administrative shell and command-line utilities for GitHub Enterprise Server, see "Accessing the administrative shell (SSH)" and "Command-line utilities."

For example, you can enable any GitHub Advanced Security feature with your infrastructure-as-code tooling when you deploy an instance for staging or disaster recovery.

  1. SSH into your GitHub Enterprise Server instance.

  2. Enable features for GitHub Advanced Security.

    • To enable Code scanning, enter the following commands.
      ghe-config app.minio.enabled true
      ghe-config app.code-scanning.enabled true
    • To enable Secret scanning, enter the following command.
      ghe-config app.secret-scanning.enabled true
    • To enable the dependency graph, enter the following command.
      ghe-config app.dependency-graph.enabled true
  3. Optionally, disable features for GitHub Advanced Security.

    • To disable code scanning, enter the following commands.
      ghe-config app.minio.enabled false
      ghe-config app.code-scanning.enabled false
    • To disable secret scanning, enter the following command.
      ghe-config app.secret-scanning.enabled false
    • To disable the dependency graph, enter the following command.
      ghe-config app.dependency-graph.enabled false
  4. Apply the configuration.

    ghe-config-apply