Enabling GitHub Advanced Security for your enterprise

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 code security and analysis for your enterprise."

API를 통해 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 GitHub Advanced Security

1. GitHub Enterprise Server의 오른쪽 위 모서리에서 프로필 사진과 엔터프라이즈 설정을 차례로 클릭합니다.

   

2. 엔터프라이즈 계정 사이드바에서 설정을 선택합니다.

3. 설정에서 라이센스 을(를) 클릭합니다.

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

Prerequisites for enabling GitHub Advanced Security

1. Upgrade your license for GitHub Enterprise Server to include GitHub Advanced Security. For information about licensing, see "GitHub Advanced Security 요금 청구 정보."

2. Download the new license file. For more information, see "GitHub Enterprise 라이선스 다운로드."

3. Upload the new license file to GitHub Enterprise Server 인스턴스. For more information, see "GitHub Enterprise Server에 새 라이선스 업로드."

4. 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 "Enabling Dependabot for your enterprise."

Enabling and disabling GitHub Advanced Security features

1. 페이지의 오른쪽 상단에 있는 GitHub Enterprise Server의 관리 계정에서 을 클릭합니다.

2. “Site admin”(사이트 관리자) 페이지에 아직 없는 경우 왼쪽 상단에서 Site admin(사이트 관리자)을 클릭합니다.

3. " 사이트 관리자" 사이드바에서 관리 콘솔 을 클릭합니다.

4. "설정" 사이드바에서 보안을 클릭합니다.

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

6. "설정" 사이드바에서 설정 저장을 클릭합니다.

   참고: 관리 콘솔에 설정을 저장하면 시스템 서비스가 다시 시작되어 사용자에게 표시되는 가동 중지 시간이 발생할 수 있습니다.

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 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 GitHub Advanced Security feature with your infrastructure-as-code tooling when you deploy an instance for staging or disaster recovery.

1. 에 SSH합니다. 인스턴스가 여러 노드로 구성된 경우(예: 고가용성 또는 지역 복제가 구성된 경우) 주 노드에 대한 SSH를 수행합니다. 클러스터를 사용하는 경우 임의 노드에 대해 SSH를 수행할 수 있습니다. HOSTNAME을 인스턴스의 호스트 이름 또는 노드의 호스트 이름이나 IP 주소로 바꿉니다. 자세한 내용은 "관리 셸(SSH)에 액세스"을(를) 참조하세요.

   Shell

   ssh -p 122 admin@HOSTNAME
   

2. Enable features for GitHub Advanced Security.

   • To enable code scanning, enter the following commands.

     Shell

     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
     

   • To enable the dependency graph, enter the following command.

     Shell

     ghe-config app.dependency-graph.enabled true
     

3. Optionally, disable features for GitHub Advanced Security.

   • To disable code scanning, enter the following commands.

     Shell

     ghe-config app.code-scanning.enabled false
     

     • Optionally, if you disable code scanning, you can also disable the internal MinIO service for GitHub 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 "Enabling Dependabot for your enterprise."

       • To disable Dependabot updates, enter the following command.

         Shell

         ghe-config app.dependabot.enabled false
         

       • To disable MinIO, enter the following command.

         Shell

         ghe-config app.minio.enabled false
         

   • To disable secret scanning, enter the following command.

     Shell

     ghe-config app.secret-scanning.enabled false
     

   • To disable the dependency graph, enter the following command.

     ghe-config app.dependency-graph.enabled false
     

4. 구성을 적용하려면 다음 명령을 실행합니다.

   참고: 구성을 실행하는 동안 의 서비스가 다시 시작될 수 있으므로 짧은 가동 중지 시간이 발생할 수 있습니다.

   Shell

   ghe-config-apply
   

5. 구성 실행이 완료될 때까지 기다립니다.