mirror of
https://github.com/hashicorp/vault-action.git
synced 2025-11-07 07:06:56 +00:00
Add GitHub authentication notice (#200)
* Add GitHub authentication notice * Typo in perm name
This commit is contained in:
parent
5e5c06a3c8
commit
937d792a86
1 changed files with 8 additions and 1 deletions
|
|
@ -71,12 +71,19 @@ with:
|
||||||
caCertificate: ${{ secrets.VAULTCA }}
|
caCertificate: ${{ secrets.VAULTCA }}
|
||||||
```
|
```
|
||||||
- **github**: you must provide the github token as `githubToken`
|
- **github**: you must provide the github token as `githubToken`
|
||||||
|
|
||||||
|
**Notice: [Vault GitHub authentication](https://www.vaultproject.io/docs/auth/github)
|
||||||
|
requires `read:org` permissions for authentication. The auto-generated `GITHUB_TOKEN`
|
||||||
|
created for projects does not have these permissions and GitHub does not allow this
|
||||||
|
token's permissions to be modified. A new GitHub Token secret must be created with
|
||||||
|
`read:org` permissions to use this authentication method.**
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
...
|
...
|
||||||
with:
|
with:
|
||||||
url: https://vault.mycompany.com:8200
|
url: https://vault.mycompany.com:8200
|
||||||
method: github
|
method: github
|
||||||
githubToken: ${{ secrets.GITHUB_TOKEN }}
|
githubToken: ${{ secrets.MY_GITHUB_TOKEN }}
|
||||||
caCertificate: ${{ secrets.VAULTCA }}
|
caCertificate: ${{ secrets.VAULTCA }}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue