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. See エンタープライズのコード セキュリティと分析のためのポリシーの適用.
API を使って GitHub Advanced Security の機能を有効または無効にすることもできます。 詳細については、REST API ドキュメントの「シークレット スキャン用の REST API エンドポイント」を参照してください。
For guidance on a phased deployment of GitHub Advanced Security, see GitHub Advanced Security の大規模な導入の概要.
Checking whether your license includes Advanced Security
- GitHub Enterprise Server の右上隅にあるプロフィール画像をクリックしてから、[Enterprise settings] をクリックします。
- ページの左側にある Enterprise アカウント サイドバーで、[ Settings] をクリックします。
- [ Settings] で、[License] をクリックします。
- If your license includes GitHub Advanced Security, the license page includes a section showing details of current usage.
Prerequisites for enabling Advanced Security
-
Upgrade your GitHub Enterprise license to include Advanced Security. For information about licensing, see GitHub Advanced Security ライセンスの課金.
-
Download the new license file. See GitHub Enterpriseのライセンスのダウンロード.
-
Upload the new license file to GitHub Enterprise Server. See GitHub Enterprise Serverへの新しいライセンスのアップロード.
-
Review the prerequisites for the features you plan to enable.
- Code scanning, see Configuring code scanning for your appliance.
- Secret scanning, see Configuring secret scanning for your appliance.
- Dependabot, see エンタープライズ向けの Dependabot の有効化.
Enabling and disabling Advanced Security features
警告
- この設定を変更すると、GitHub Enterprise Server 上のユーザーが利用するサービスが再起動されます。 ユーザーのダウンタイムを最小限に抑えるために、この変更のタイミングは慎重に決めてください。
-
GitHub Enterprise Server の管理アカウントから、任意のページの右上隅にある をクリックします。
-
[サイト管理者] ページにまだ表示されていない場合は、左上隅の [サイト管理者] をクリックします。
-
[ Site admin] サイドバーで、[[Management Console]] をクリックします。
-
[設定] サイドバーで [セキュリティ] をクリックします。
-
Under "Security," select the features that you want to enable and deselect any features you want to disable.
-
[設定] サイドバーで [設定の保存] をクリックします。
メモ
[Management Console] で設定を保存すると、システム サービスが再起動され、ユーザーにわかるダウンタイムが発生する可能性があります。
-
設定の実行が完了するのを待ってください。
When GitHub Enterprise Server has finished restarting, you're ready to set up any additional resources required for newly enabled features. See Configuring code scanning for your appliance.
Enabling or disabling Advanced Security features via the administrative shell (SSH)
You can enable or disable features programmatically on GitHub Enterprise Server. For more information about the administrative shell and command-line utilities for GitHub Enterprise Server, see 管理シェル (SSH) にアクセスする and コマンド ライン ユーティリティ.
For example, you can enable any Advanced Security feature with your infrastructure-as-code tooling when you deploy an instance for staging or disaster recovery.
-
お使いの GitHub Enterprise Server インスタンス に SSH で接続します。 インスタンスが複数のノードで構成されている場合は (高可用性や geo レプリケーションが構成されている場合など)、プライマリ ノードに SSH 接続します。 クラスターを使用する場合は、任意のノードに SSH 接続できます。 HOSTNAME をインスタンスのホスト名、またはノードのホスト名または IP アドレスに置き換えます。 詳しくは、「管理シェル (SSH) にアクセスする」をご覧ください。
Shell ssh -p 122 admin@HOSTNAME
ssh -p 122 admin@HOSTNAME -
Enable features for Advanced Security.
-
To enable code scanning, enter the following commands.
Shell ghe-config app.minio.enabled true ghe-config app.code-scanning.enabled true
ghe-config app.minio.enabled true ghe-config app.code-scanning.enabled true -
To enable secret scanning, enter the following command.
Shell ghe-config app.secret-scanning.enabled true
ghe-config app.secret-scanning.enabled true -
To enable the dependency graph, enter the following command.
Shell ghe-config app.dependency-graph.enabled true
ghe-config app.dependency-graph.enabled true
-
-
Optionally, disable features for Advanced Security.
-
To disable code scanning, enter the following commands.
Shell ghe-config app.code-scanning.enabled false
ghe-config app.code-scanning.enabled false-
Optionally, if you disable code scanning, you can also disable the internal MinIO service for Advanced Security. If Dependabot updates are enabled for the instance and you want to disable this service, you must also disable Dependabot updates. Disabling the service does not affect MinIO storage for GitHub Actions or GitHub Packages. For more information about Dependabot updates, see エンタープライズ向けの Dependabot の有効化.
-
To disable Dependabot updates, enter the following command.
Shell ghe-config app.dependabot.enabled false
ghe-config app.dependabot.enabled false -
To disable MinIO, enter the following command.
Shell ghe-config app.minio.enabled false
ghe-config app.minio.enabled false
-
-
-
To disable secret scanning, enter the following command.
Shell ghe-config app.secret-scanning.enabled false
ghe-config app.secret-scanning.enabled false -
To disable the dependency graph, enter the following command.
ghe-config app.dependency-graph.enabled false
-
-
構成を適用するには、次のコマンドを実行します。
メモ
構成の実行中に、お使いの GitHub Enterprise Server インスタンス 上のサービスが再起動する可能性があり、これによりユーザーに短時間のダウンタイムが発生する場合があります。
Shell ghe-config-apply
ghe-config-apply -
設定の実行が完了するのを待ってください。