Skip to content

Commit dc2ba53

Browse files
authored
GitHub Enterprise Server 3.6 release candidate (github#28905)
1 parent 7e22489 commit dc2ba53

File tree

210 files changed

+1166480
-343
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

210 files changed

+1166480
-343
lines changed

Diff for: -

Whitespace-only changes.
Loading
Loading
Loading
8.62 KB
Loading
-40.4 KB
Loading
Loading
9.96 KB
Loading

Diff for: assets/images/help/repository/require-signoffs.png

9.96 KB
Loading
Loading
Loading
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,50 @@
11
---
22
title: Managing accessibility settings
3-
intro: 'You can disable character key shortcuts on {% data variables.product.prodname_dotcom %} in your accessibility settings.'
3+
shortTitle: Manage accessibility settings
4+
intro: "{% data variables.product.product_name %}'s user interface can adapt to your vision, hearing, motor, cognitive, or learning needs."
45
versions:
56
feature: keyboard-shortcut-accessibility-setting
67
redirect_from:
78
- /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-accessibility-settings
9+
type: how_to
10+
miniTocMaxHeadingLevel: 3
811
---
912

1013
## About accessibility settings
1114

12-
{% data variables.product.product_name %} includes a variety of keyboard shortcuts so that you can perform actions across the site without using your mouse to navigate. While shortcuts are useful to save time, they can sometimes make {% data variables.product.prodname_dotcom %} harder to use and less accessible.
15+
To accommodate your vision, hearing, motor, cognitive, or learning needs, you can customize the user interface for {% data variables.product.product_location %}.
1316

14-
All keyboard shortcuts are enabled by default on {% data variables.product.product_name %}, but you can choose to disable character key shortcuts in your accessibility settings. This setting does not affect keyboard shortcuts provided by your web browser or {% data variables.product.prodname_dotcom %} shortcuts that use a modifier key such as <kbd>Control</kbd> or <kbd>Command</kbd>.
17+
## Managing accessibility settings
1518

16-
## Managing character key shortcuts
19+
You can decide whether you want to use some or all keyboard shortcuts on {% ifversion fpt or ghec %}{% data variables.product.product_location %}{% elsif ghes or ghae %}the website for {% data variables.product.product_location %}{% endif %}, and you can control the display of animated images.
20+
21+
### Managing keyboard shortcuts
22+
23+
You can perform actions across the {% data variables.product.product_name %} website without using your mouse by using your keyboard instead. Keyboard shortcuts can be useful to save time for some people, but may interfere with accessibility if you don't intend to use the shortcuts.
24+
25+
By default, all keyboard shortcuts are enabled on {% data variables.product.product_name %}. For more information, see "[Keyboard shortcuts](/get-started/using-github/keyboard-shortcuts)."
1726

1827
{% data reusables.user-settings.access_settings %}
1928
{% data reusables.user-settings.accessibility_settings %}
20-
1. Select or deselect the **Enable character key shortcuts** checkbox.
21-
![Screenshot of the 'Enable character key shortcuts' checkbox](/assets/images/help/settings/disable-character-key-shortcuts.png)
22-
2. Click **Save**.
29+
1. Under "Keyboard shortcuts", manage settings for your keyboard shortcuts.
30+
31+
- Optionally, to disable or enable shortcut keys that don't use modifiers keys like <kbd>Control</kbd> or <kbd>Command</kbd>, under "General", deselect **Character keys**. If you disable character keys, you may still be able to trigger shortcuts for your web browser, and you can still trigger shortcuts for {% data variables.product.product_name %} that use a modifier key.
32+
{%- ifversion command-palette %}
33+
- Optionally, to customize the keyboard shortcuts for triggering the command palette, under "Command palette", use the drop-down menus to choose a keyboard shortcut. For more information, see "[{% data variables.product.company_short %} Command Palette](/get-started/using-github/github-command-palette)."
34+
{%- endif %}
35+
36+
{% ifversion motion-management %}
37+
38+
### Managing motion
39+
40+
You can control how {% data variables.product.product_name %} displays animated images.
41+
42+
By default, {% data variables.product.product_name %} syncs with your system-level preference for reduced motion. For more information, see the documentation or settings for your operating system.
43+
44+
{% data reusables.user-settings.access_settings %}
45+
{% data reusables.user-settings.accessibility_settings %}
46+
1. Under "Motion", manage settings for motion.
47+
48+
- Optionally, to control how {% data variables.product.product_name %} displays animaged images, under "Autoplay animated images", select **Sync with system**, **Enabled**, or **Disabled**.
49+
50+
{% endif %}

Diff for: content/actions/using-workflows/events-that-trigger-workflows.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ on:
185185
deployment_status
186186
```
187187

188-
{% ifversion fpt or ghec %}
188+
{% ifversion discussions %}
189189
### `discussion`
190190

191191
| Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` |

Diff for: content/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise.md

-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ topics:
1010
shortTitle: Server Statistics
1111
---
1212

13-
{% data reusables.server-statistics.release-phase %}
14-
1513
## About {% data variables.product.prodname_server_statistics %}
1614

1715
{% data variables.product.prodname_server_statistics %} collects aggregate usage data from {% data variables.product.product_location %}, which you can use to better anticipate the needs of your organization, understand how your team works, and show the value you get from {% data variables.product.prodname_ghe_server %}.

Diff for: content/admin/configuration/configuring-your-enterprise/command-line-utilities.md

+14
Original file line numberDiff line numberDiff line change
@@ -737,6 +737,20 @@ This utility rewrites the imported repository. This gives you a chance to rename
737737
git-import-rewrite
738738
```
739739

740+
{% ifversion ghes > 3.3 %}
741+
742+
## Security
743+
744+
### ghe-find-insecure-git-operations
745+
746+
This utility searches your instance's logs and identifies Git operations over SSH that use insecure algorithms or hash functions, including DSA, RSA-SHA-1, HMAC-SHA-1, and CBC ciphers. You can use the output to support each client's transition to a more secure SSH connection. For more information, see [{% data variables.product.prodname_blog %}](https://github.blog/2022-06-28-improving-git-protocol-security-on-github-enterprise-server){% ifversion ghes < 3.6 %}.{% elsif ghes > 3.5 %} and "[Configuring SSH connections to your instance](/admin/configuration/configuring-your-enterprise/configuring-ssh-connections-to-your-instance)."{% endif %}
747+
748+
```shell
749+
ghe-find-insecure-git-operations
750+
```
751+
752+
{% endif %}
753+
740754
## Support
741755

742756
### ghe-diagnostics

Diff for: content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md

+12
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,18 @@ settings to allow incoming emails](#configuring-dns-and-firewall-settings-to-all
8585
![Save settings button](/assets/images/enterprise/management-console/save-settings.png)
8686
{% data reusables.enterprise_site_admin_settings.wait-for-configuration-run %}
8787

88+
{% ifversion require-tls-for-smtp %}
89+
## Enforcing TLS for SMTP connections
90+
91+
You can enforce TLS encryption for all incoming SMTP connections, which can help satisfy an ISO-27017 certification requirement.
92+
93+
{% data reusables.enterprise_site_admin_settings.email-settings %}
94+
1. Under "Authentication," select **Enforce TLS auth (recommended)**.
95+
96+
![Screenshot of the "Enforce TLS auth (recommended)" checkbox](/assets/images/enterprise/configuration/enforce-tls-for-smtp-checkbox.png)
97+
{% data reusables.enterprise_management_console.save-settings %}
98+
{% endif %}
99+
88100
## Configuring DNS and firewall settings to allow incoming emails
89101

90102
If you want to allow email replies to notifications, you must configure your DNS settings.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Configuring host keys for your instance
3+
shortTitle: Configure host keys
4+
intro: 'You can increase the security of {% data variables.product.product_location %} by configuring the algorithms that your instance uses to generate and advertise host keys for incoming SSH connections.'
5+
permissions: "Site administrators can configure the host keys for a {% data variables.product.product_name %} instance."
6+
versions:
7+
ghes: '>= 3.6'
8+
type: how_to
9+
topics:
10+
- Authentication
11+
- Enterprise
12+
- Infrastructure
13+
- Networking
14+
- Security
15+
- SSH
16+
---
17+
18+
## About host keys for your instance
19+
20+
Servers that accept SSH connections advertise one or more cryptographic host keys to securely identify the server to SSH clients. To confirm the server's identity during the initialization of a connection, clients store and verify the host key. For more information, see [SSH Host Key - What, Why, How](https://ssh.com/academy/ssh/host-key) on the SSH Academy website.
21+
22+
{% data reusables.enterprise.about-ssh-ports %}
23+
24+
By default, {% data variables.product.product_location %} generates and advertises host keys with OpenSSH-style host key rotation. To increase the security of SSH in your environment, you can enable additional algorithms for the generation of host keys.
25+
26+
{% note %}
27+
28+
**Note**: If you enable additional host key algorithms, clients that do not use OpenSSH for SSH connections may experience warnings during connection, or fail to connect entirely. Some SSH implementations can ignore unsupported algorithms and fall back to a different algorithm. If the client does not support fallback, the connection will fail. For example, the SSH library for Go does not support fallback to a different algorithm.
29+
30+
{% endnote %}
31+
32+
## Managing an Ed25519 host key
33+
34+
To improve security for clients that connect to {% data variables.product.product_location %}, you can enable the generation and advertisement of an Ed25519 host key. Ed25519 is immune to some attacks that target older signature algorithms, without sacrificing speed. Older SSH clients may not support Ed25519. By default, {% data variables.product.product_name %} instances do not generate or advertise an Ed25519 host key. For more information, see [the Ed25519 website](https://ed25519.cr.yp.to).
35+
36+
{% data reusables.enterprise_installation.ssh-into-instance %}
37+
1. To enable generation and advertisement of the Ed25519 host key, enter the following command.
38+
39+
```shell
40+
ghe-config app.babeld.host-key-ed25519 true
41+
```
42+
1. Optionally, enter the following command to disable generation and advertisement of the Ed25519 host key.
43+
44+
```shell
45+
ghe-config app.babeld.host-key-ed25519 false
46+
```
47+
{% data reusables.enterprise.apply-configuration %}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: Configuring SSH connections to your instance
3+
shortTitle: Configure SSH connections
4+
intro: 'You can increase the security of {% data variables.product.product_location %} by configuring the SSH algorithms that clients can use to establish a connection.'
5+
permissions: "Site administrators can configure SSH connections to a {% data variables.product.product_name %} instance."
6+
versions:
7+
ghes: '>= 3.6'
8+
type: how_to
9+
topics:
10+
- Authentication
11+
- Enterprise
12+
- Infrastructure
13+
- Networking
14+
- Security
15+
- SSH
16+
---
17+
18+
## About SSH connections to your instance
19+
20+
{% data reusables.enterprise.about-ssh-ports %}
21+
22+
To accommodate the SSH clients in your environment, you can configure the types of connections that {% data variables.product.product_location %} will accept.
23+
24+
## Configuring SSH connections with RSA keys
25+
26+
When users perform Git operations on {% data variables.product.product_location %} via SSH over port 22, the client can authenticate with an RSA key. The client may sign the attempt using the SHA-1 hash function. In this context, the SHA-1 hash function is no longer secure. For more information, see [SHA-1](https://en.wikipedia.org/wiki/SHA-1) on Wikipedia.
27+
28+
By default{% ifversion ghes < 3.7 %} on {% data variables.product.product_name %} 3.6 and later{% endif %}, SSH connections that satisfy **both** of the following conditions will fail.
29+
30+
{% data reusables.ssh.rsa-sha-1-connection-failure-criteria %}
31+
32+
You can adjust the cutoff date. If the user uploaded the RSA key before the cutoff date, the client can continue to connect successfuly using SHA-1 as long as the key remains valid. Alternatively, you can reject all SSH connections authenticated with an RSA key if the client signs the connection using the SHA-1 hash function.
33+
34+
Regardless of the setting you choose for your instance, clients can continue to connect using any RSA key signed with a SHA-2 hash function.
35+
36+
If you use an SSH certificate authority, connections will fail if the certificate's `valid_after` date is after the cutoff date. For more information, see "[About SSH certificate authorities](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)."
37+
38+
For more information, see [{% data variables.product.prodname_blog %}](https://github.blog/2022-06-28-improving-git-protocol-security-on-github-enterprise-server).
39+
40+
{% data reusables.enterprise_installation.ssh-into-instance %}
41+
1. Audit your instance's logs for connections that use unsecure algorithms or hash functions using the `ghe-find-insecure-git-operations` utility. For more information, see "[Command-line utilities](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-find-insecure-git-operations)."
42+
1. To configure a cutoff date after which {% data variables.product.product_location %} will deny connections from clients that use an RSA key uploaded after the date if the connection is signed by the SHA-1 hash function, enter the following command. Replace _**RFC-3399-UTC-TIMESTAMP**_ with a valid RFC 3399 UTC timestamp. For example, the default value, August 1, 2022, would be represented as `2022-08-01T00:00:00Z`. For more information, see [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) on the IETF website.
43+
44+
<pre>
45+
$ ghe-config app.gitauth.rsa-sha1 <em>RFC-3339-UTC-TIMESTAMP</em>
46+
</pre>
47+
1. Alternatively, to completely disable SSH connections using RSA keys that are signed with the SHA-1 hash function, enter the following command.
48+
49+
```shell
50+
ghe-config app.gitauth.rsa-sha1 false
51+
```
52+
{% data reusables.enterprise.apply-configuration %}

Diff for: content/admin/configuration/configuring-your-enterprise/index.md

+2
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ children:
2525
- /site-admin-dashboard
2626
- /enabling-private-mode
2727
- /managing-github-mobile-for-your-enterprise
28+
- /configuring-ssh-connections-to-your-instance
2829
- /configuring-email-for-notifications
2930
- /verifying-or-approving-a-domain-for-your-enterprise
3031
- /configuring-rate-limits
@@ -34,6 +35,7 @@ children:
3435
- /command-line-utilities
3536
- /restricting-network-traffic-to-your-enterprise
3637
- /configuring-github-pages-for-your-enterprise
38+
- /configuring-host-keys-for-your-instance
3739
- /configuring-the-referrer-policy-for-your-enterprise
3840
- /configuring-custom-footers
3941
- /configuring-web-commit-signing

Diff for: content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Then,{% else %}First,{% endif %} decide whether you'll allow third-party actions
4040
Consider combining OpenID Connect (OIDC) with reusable workflows to enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows. For more information, see "[Using OpenID Connect with reusable workflows](/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows)."
4141
{% endif %}
4242

43-
You can access information about activity related to {% data variables.product.prodname_actions %} in the audit logs for your enterprise. If your business needs require retaining audit logs for longer than six months, plan how you'll export and store this data outside of {% data variables.product.prodname_dotcom %}. For more information, see {% ifversion ghec %}"[Streaming the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise)" and "[Exporting audit log activity for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/exporting-audit-log-activity-for-your-enterprise)."{% else %}"[Log forwarding](/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/log-forwarding)."{% endif %}
43+
You can access information about activity related to {% data variables.product.prodname_actions %} in the audit logs for your enterprise. If your business needs require retaining this information longer than audit log data is retained, plan how you'll export and store this data outside of {% data variables.product.prodname_dotcom %}. For more information, see {% ifversion ghec %}"[Exporting audit log activity for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/exporting-audit-log-activity-for-your-enterprise)" and "[Streaming the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise)."{% else %}{% ifversion audit-log-streaming %}"[Streaming the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise)" and {% endif %}"[Log forwarding](/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/log-forwarding)."{% endif %}
4444

4545
![Audit log entries](/assets/images/help/repository/audit-log-entries.png)
4646

Diff for: content/admin/guides.md

+2
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ includeGuides:
5252
- /admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise
5353
- /admin/configuration/configuring-your-enterprise/managing-github-mobile-for-your-enterprise
5454
- /admin/configuration/connecting-your-enterprise-account-to-github-enterprise-cloud
55+
- /admin/configuration/configuring-your-enterprise/configuring-ssh-connections-to-your-instance
56+
- /admin/configuration/configuring-your-enterprise/configuring-host-keys-for-your-instance
5557
- /admin/configuration/enabling-and-scheduling-maintenance-mode
5658
- /admin/configuration/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise
5759
- /admin/configuration/enabling-private-mode

Diff for: content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics.md

-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ topics:
1010
- Enterprise
1111
---
1212

13-
{% data reusables.server-statistics.release-phase %}
14-
1513
## About the benefits of {% data variables.product.prodname_server_statistics %}
1614

1715
{% data variables.product.prodname_server_statistics %} can help you anticipate the needs of your organization, understand how your team works, and show the value you get from {% data variables.product.prodname_ghe_server %}.

Diff for: content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/exporting-server-statistics.md

-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ redirect_from:
88
- /early-access/github/analyze-how-your-team-works-with-server-statistics/exploring-server-statistics
99
---
1010

11-
{% data reusables.server-statistics.release-phase %}
12-
1311
You can download up to the last 365 days of {% data variables.product.prodname_server_statistics %} data in a CSV or JSON file. This data, which includes aggregate metrics on repositories, issues, and pull requests, can help you anticipate the needs of your organization, understand how your team works, and show the value you get from {% data variables.product.prodname_ghe_server %}.
1412

1513
Before you can download this data, you must enable {% data variables.product.prodname_server_statistics %}. For more information, see "[Enabling {% data variables.product.prodname_server_statistics %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)."

Diff for: content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api.md

-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ redirect_from:
88
- /early-access/github/analyze-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api
99
---
1010

11-
{% data reusables.server-statistics.release-phase %}
12-
1311
You can request up to 365 days of metrics in a single {% data variables.product.prodname_server_statistics %} REST API request. This data, which includes aggregate metrics on repositories, issues, and pull requests, can help you anticipate the needs of your organization, understand how your team works, and show the value you get from {% data variables.product.prodname_ghe_server %}. For a list of the metrics collected, see "[{% data variables.product.prodname_server_statistics %} data collected](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)."
1412

1513
Before you can use the {% data variables.product.prodname_server_statistics %} REST API, you must enable {% data variables.product.prodname_server_statistics %}. For more information, see "[Enabling {% data variables.product.prodname_server_statistics %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)."

0 commit comments

Comments
 (0)