From ae59805a4ba2e192c23515711ed3a0997b732171 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Wed, 18 Dec 2024 02:00:04 +0900 Subject: [PATCH] Edit docs/configuring-playbook-bridge-hookshot.md: clarify when it is needed to download the private key file of a GitHub app Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bridge-hookshot.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/configuring-playbook-bridge-hookshot.md b/docs/configuring-playbook-bridge-hookshot.md index cc96a4d31..f4b252fc4 100644 --- a/docs/configuring-playbook-bridge-hookshot.md +++ b/docs/configuring-playbook-bridge-hookshot.md @@ -12,7 +12,9 @@ See the project's [documentation](https://matrix-org.github.io/matrix-hookshot/l ### Download GitHub app private key -If you're setting up the GitHub bridge, you'll need to generate and download a private key file after you created your GitHub app. +If you're setting up the GitHub bridge, you need to create your GitHub app, and generate a private key file of it. + +You need to download the private key file, if you will install the file manually or with the `aux` role. For details, see [the section below](#manage-github-private-key-with-aux-role). ## Adjusting the playbook configuration