Skip to content

Commit 6f46483

Browse files
authored
Document ghe-config command to enable/disable Code Scanning (#2932)
1 parent 6168379 commit 6f46483

1 file changed

Lines changed: 22 additions & 1 deletion

File tree

content/admin/configuration/configuring-code-scanning-for-your-appliance.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ For the users of {% data variables.product.product_location %} to be able to ena
4242
![Checkbox to enable or disable {% data variables.product.prodname_code_scanning %}](/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png)
4343
{% data reusables.enterprise_management_console.save-settings %}
4444

45-
4645
### Running {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_actions %}
4746

4847
#### Setting up a self-hosted runner
@@ -89,3 +88,25 @@ The {% data variables.product.prodname_codeql_runner %} is a command-line tool t
8988
1. Under "{% data variables.product.prodname_advanced_security %}", unselect **{% data variables.product.prodname_code_scanning_capc %}**.
9089
![Checkbox to enable or disable {% data variables.product.prodname_code_scanning %}](/assets/images/enterprise/management-console/code-scanning-disable.png)
9190
{% data reusables.enterprise_management_console.save-settings %}
91+
92+
### Enabling or disabling {% data variables.product.prodname_code_scanning %} via the administrative shell (SSH)
93+
94+
You can enable or disable {% data variables.product.prodname_code_scanning %} programmatically on {% data variables.product.product_location %}. For example, you can enable {% data variables.product.prodname_code_scanning %} with your infrastructure-as-code tooling when you deploy an instance for staging or disaster recovery.
95+
96+
For more information about the administrative shell and command-line utilities for {% data variables.product.prodname_ghe_server %}, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)" and "[Command-line utilities](/admin/configuration/command-line-utilities#ghe-config)."
97+
98+
1. SSH into {% data variables.product.product_location %}.
99+
1. Enable {% data variables.product.prodname_code_scanning %}.
100+
```shell
101+
ghe-config app.minio.enabled true
102+
ghe-config app.code-scanning.enabled true
103+
```
104+
2. Optionally, disable {% data variables.product.prodname_code_scanning %}.
105+
```shell
106+
ghe-config app.minio.enabled false
107+
ghe-config app.code-scanning.enabled false
108+
```
109+
3. Apply the configuration.
110+
```shell
111+
ghe-config-apply
112+
```

0 commit comments

Comments
 (0)