Skip to content

Commit

Permalink
[ci skip] readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
joemiller committed Jul 26, 2019
1 parent 747ae15 commit 90e8256
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,22 +24,22 @@ Install

### One-line install

| OS | Command |
| ---------------------------------- | ------------------------------------------------ |
| macOS | `brew install joemiller/taps/vault-token-helper` |
| Linux<br>(LinuxBrew)<br>*untested* | `brew install joemiller/taps/vault-token-helper` |
| OS | Command |
|---------------------------------|--------------------------------------------------|
| macOS | `brew install joemiller/taps/vault-token-helper` |
| Linux<br>(LinuxBrew) *untested* | `brew install joemiller/taps/vault-token-helper` |

### Linux packages

| Format | Arch |
| ------ | ----- |
|--------|-------|
| [rpm] | amd64 |
| [deb] | amd64 |

### Pre-built binaries

| OS | Arch | binary |
| ------- | ----- | ------------------------------------- |
|---------|-------|---------------------------------------|
| macOS | amd64 | [vault-token-helper][latest-binaries] |
| Linux | amd64 | [vault-token-helper][latest-binaries] |
| Windows | amd64 | [vault-token-helper][latest-binaries] |
Expand Down Expand Up @@ -73,7 +73,8 @@ Releases are signed using the project GPG key with key-ID `37F9D1272278CD32` and
gpg --recv-keys 37F9D1272278CD32
```

Download and verify the signature on the checksum file:
[Download](https://github.com/joemiller/vault-token-helper/releases/latest) and verify the signature
on the checksum file:

```console
gpg --verify vault-token-helper_0.2.0_checksums.txt.sig vault-token-helper_0.2.0_checksums.txt
Expand All @@ -86,6 +87,8 @@ release artifacts:
shasum --check vault-token-helper_0.2.0_checksums.txt
```

macOS binaries are codesign'd.

Usage
-----

Expand All @@ -107,8 +110,10 @@ token_helper = "/install/path/to/vault-token-helper"

### Configure vault-token-helper

For most installations the defaults should be sufficient. An optional configuration file
located at `$HOME/.vault-token-helper.yaml` can be used to override the defaults.
For most installations the defaults should be sufficient.

An optional configuration file located at `$HOME/.vault-token-helper.yaml` can be used to
override the defaults.

A fully annotated example config file is available in [./vault-token-helper.annotated.yaml](./vault-token-helper.annotated.yaml)

Expand Down Expand Up @@ -142,6 +147,7 @@ There are a few additional commands:

```console
$ vault-token-helper list --extended

VAULT_ADDR display_name ttl renewable policies
---------- ------------ --- --------- --------
https://vault-prod.dom.tld:8200 [email protected] 527h46m18s true [admin default]
Expand Down

0 comments on commit 90e8256

Please sign in to comment.