Skip to content

Commit

Permalink
add install troubleshooting to readme (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
colinhoglund authored Jun 13, 2023
1 parent 3bad347 commit 83717d3
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,29 @@ Install compiled binary as a Helm plugin (requires [Helm](https://docs.helm.sh/u

helm plugin install https://github.com/kanopy-platform/ksec

Please Note: This may not work on Windows if you have spaces in your `HELM_HOME` path. You can instead download the windows executable from the [latest release](https://github.com/kanopy-platform/ksec/releases/latest).

Install from source (requires [golang](https://golang.org/doc/install#install)).

go get github.com/kanopy-platform/ksec/cmd/...

### Trobleshooting

#### Windows: Spaces in `HELM_HOME`

`helm plugin install` may not work on Windows if you have spaces in your `HELM_HOME` path. You can instead download the windows executable from the [latest release](https://github.com/kanopy-platform/ksec/releases/latest).

#### Helm Install Errors

You may need to remove a plugin and clear your plugin cache if you have errors installing a plugin.

macOS
```
# rm cache
rm -rf ~/Library/Caches/helm/plugins/https-github.com-kanopy-platform-ksec*
# rm plugin
rm -rf ~/Library/helm/plugins/ksec/
```

## Usage
```
A tool for managing Kubernetes Secret data
Expand Down

0 comments on commit 83717d3

Please sign in to comment.