nodejs/hookshot
nodejs/hookshot
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-hookshot.git synced 2025-03-10 21:19:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Mention github login and github status in docs (#415)

Browse Source 
* Mention `github status` in docs

instead of `github hastoken`, which was renamed.

Signed-off-by: Andrew Ferrazzutti <andrewf@element.io>

* Document `github login`

Signed-off-by: Andrew Ferrazzutti <andrewf@element.io>
This commit is contained in:
Andrew Ferrazzutti 2022-07-14 10:57:19 -04:00 committed by GitHub
parent eac6819a58
commit 3dcb6e857a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/415.doc Normal file
View File

@ -0,0 +1 @@
Update GitHub authentication documentation: list the steps for OAuth login (`github login`), and mention the correct command for checking GitHub authentication status (`github status`).

11
docs/usage/auth.md
View File

@ -31,7 +31,16 @@ To authenticate with a personal access token:
1. Send the generated token to the bridge by saying `github setpersonaltoken %your-token%`. You can redact 1. Send the generated token to the bridge by saying `github setpersonaltoken %your-token%`. You can redact
the message afterwards if you like. the message afterwards if you like.
1. The bridge will have connected you. You can check the status at any time by saying `github hastoken` 1. The bridge will have connected you.
To authenticate via OAuth, you will need to have configured OAuth support in your config.yml, and have the endpoints required accessible from the internet.
- Say `github login` to get the URL to authenticate via.
- Click the URL sent by the bot.
- Follow the steps, ensuring you authenticate with the right user.
- If all goes well, you will now be connected.
You can check the status of authenticated instances by saying `github status`.
## GitLab ## GitLab