Skip to content

Commit c711998

Browse files
committed
Adding upgrade information to the readme
1 parent e56c7af commit c711998

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,26 @@ We all know storing secrets in plain text can pose major security threats, and T
1414

1515
## Windows Install via Chocolatey
1616
The fastest way to install `terracreds` on Windows is via our Chocolatey package:
17-
```bash
17+
```powershell
1818
choco install terracreds -y
1919
```
2020

2121
Once installed run the following command to verify `terracreds` was installed properly:
22-
```bash
22+
```powershell
2323
terracreds -v
2424
```
25+
26+
To upgrade `terracreds` to the latest version with Chocolatey run the the following command:
27+
```powershell
28+
choco upgrade terracreds -y
29+
```
30+
2531
## macOS Install
2632
We are currently working on a `homebrew` package, however, to install the package simply download our latest release from this repository,
2733
extract the package, and then place it in a directory available on `$HOME`
2834

2935
## Linux Install
30-
You'll need to download the latest binary from our release page and place anywhere on `$PATH` of your system. You can also copy and run the following commands:
36+
You'll need to download the latest binary from our release page and place it anywhere on `$PATH` of your system. You can also copy and run the following commands:
3137

3238
```bash
3339
wget https://github.com/tonedefdev/terracreds/releases/download/untagged-89883151b71ff5a64c29/terracreds_1.1.1_linux_amd64.tar.gz \
@@ -58,7 +64,7 @@ You can verify that it's running properly with:
5864
ps -ef | grep 'gnome-keyring-daemon'
5965
```
6066

61-
## Manual Install
67+
## Install From Source
6268
Download the source files by entering the following command:
6369
```go
6470
go get github.com/tonedefev/terracreds
@@ -83,6 +89,9 @@ go install -v
8389

8490
Navigate to the root of the project directory and you should see the `terracreds.exe` binary for Windows or `terracreds` for macOS and Linux. On Windows, copy the `.exe` to any directory of your choosing. Be sure to add the directory on `$env:PATH` for Windows to make using the application easier. On macOS and Linux we recommend you place the binary in `/usr/bin` as this directory should already be on the `$PATH` environment variable
8591

92+
## Upgrading
93+
If you're upgrading to the latest version of `terracreds` from a previous version use one of the methods above to install the latest binary. Once successfully installed on your system you just need to run `terracreds generate` to copy the latest version to the correct `plugins` directory for your operating system
94+
8695
## Initial Configuration
8796
In order for `terracreds` to act as your credential provider you'll need to generate the binary and the plugin directory in the default location that Terraform looks for plugins. Specifically, for credential helpers, and for Windows, the directory is `%APPDATA%\terraform.d\plugins` and for macOS and Linux `$HOME/.terraform.d/.terraformrc`
8897

0 commit comments

Comments
 (0)