Fix web commit signing docs to not require web-flow username (#30797)

Co-authored-by: Vanessa <vgrl@github.com>
This commit is contained in:
Brad Willis 2022-09-19 17:42:38 -04:00 коммит произвёл GitHub
Родитель f8e9f90af0
Коммит 9caba1ece2
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
3 изменённых файлов: 7 добавлений и 6 удалений

Просмотреть файл

@ -23,6 +23,7 @@ You can enable web commit signing, rotate the private key used for web commit si
## Enabling web commit signing
{% data reusables.enterprise_site_admin_settings.create-pgp-key-web-commit-signing %}
- Use `web-flow` as the username. If `web-flow` is unavailable or unusable, use any new unique username. Use this username throughout the following steps in this article.
- If you have a no-reply email address defined in the {% data variables.enterprise.management_console %}, use that email address. If not, use any email address, such as `web-flow@my-company.com`. The email address does not need to be valid.
{% data reusables.enterprise_site_admin_settings.pgp-key-no-passphrase %}
{% data reusables.enterprise_site_admin_settings.pgp-key-env-variable %}
@ -38,11 +39,11 @@ You can enable web commit signing, rotate the private key used for web commit si
ghe-config-apply
```
1. Create a new user on {% data variables.product.product_location %} via built-in authentication or external authentication. For more information, see "[About authentication for your enterprise](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)."
- The user's username must be `web-flow`.
- The user's email address must be the same address you used for the PGP key.
- The user's username must be the same username you used when creating the PGP key in step 1 above, for example, `web-flow`.
- The user's email address must be the same address you used when creating the PGP key.
{% data reusables.enterprise_site_admin_settings.add-key-to-web-flow-user %}
{% data reusables.enterprise_site_admin_settings.email-settings %}
1. Under "No-reply email address", type the same email address you used for the PGP key.
1. Under "No-reply email address", type the same email address you used when creating the PGP key.
{% note %}
@ -54,7 +55,8 @@ You can enable web commit signing, rotate the private key used for web commit si
## Rotating the private key used for web commit signing
{% data reusables.enterprise_site_admin_settings.create-pgp-key-web-commit-signing %}
- Use the no-reply email address defined in the {% data variables.enterprise.management_console %}, which should be the same as the email address of the `web-flow` user.
- Use the web commit signing user's username, for example, `web-flow`.
- Use the no-reply email address defined in the {% data variables.enterprise.management_console %}, which should be the same as the email address of the web commit signing user, for example, `web-flow`.
{% data reusables.enterprise_site_admin_settings.pgp-key-no-passphrase %}
{% data reusables.enterprise_site_admin_settings.pgp-key-env-variable %}
{% data reusables.enterprise_site_admin_settings.update-commit-signing-service %}

Просмотреть файл

@ -4,7 +4,7 @@
gpg --armor --export KEY-ID
```
1. Copy your PGP key, beginning with `-----BEGIN PGP PUBLIC KEY BLOCK-----` and ending with `-----END PGP PUBLIC KEY BLOCK-----`.
1. Sign into {% data variables.product.prodname_ghe_server %} as the `web-flow` user.
1. Sign into {% data variables.product.prodname_ghe_server %} as the user created for web commit signing, for example, `web-flow`.
1. Add the public PGP key to the user's profile. For more information, see "[Adding a GPG key to your {% data variables.product.prodname_dotcom %} account](/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account)."
{% note %}

Просмотреть файл

@ -5,4 +5,3 @@
```
- Use the default key type and at least `4096` bits with no expiry.
- Use `web-flow` as the username.