Skip to content

Commit 83717d3

Browse files
authored
add install troubleshooting to readme (#16)
1 parent 3bad347 commit 83717d3

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,29 @@ Install compiled binary as a Helm plugin (requires [Helm](https://docs.helm.sh/u
1313

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

16-
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).
17-
1816
Install from source (requires [golang](https://golang.org/doc/install#install)).
1917

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

20+
### Trobleshooting
21+
22+
#### Windows: Spaces in `HELM_HOME`
23+
24+
`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).
25+
26+
#### Helm Install Errors
27+
28+
You may need to remove a plugin and clear your plugin cache if you have errors installing a plugin.
29+
30+
macOS
31+
```
32+
# rm cache
33+
rm -rf ~/Library/Caches/helm/plugins/https-github.com-kanopy-platform-ksec*
34+
35+
# rm plugin
36+
rm -rf ~/Library/helm/plugins/ksec/
37+
```
38+
2239
## Usage
2340
```
2441
A tool for managing Kubernetes Secret data

0 commit comments

Comments
 (0)