You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-4Lines changed: 13 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,20 +14,26 @@ We all know storing secrets in plain text can pose major security threats, and T
14
14
15
15
## Windows Install via Chocolatey
16
16
The fastest way to install `terracreds` on Windows is via our Chocolatey package:
17
-
```bash
17
+
```powershell
18
18
choco install terracreds -y
19
19
```
20
20
21
21
Once installed run the following command to verify `terracreds` was installed properly:
22
-
```bash
22
+
```powershell
23
23
terracreds -v
24
24
```
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
+
25
31
## macOS Install
26
32
We are currently working on a `homebrew` package, however, to install the package simply download our latest release from this repository,
27
33
extract the package, and then place it in a directory available on `$HOME`
28
34
29
35
## 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:
@@ -58,7 +64,7 @@ You can verify that it's running properly with:
58
64
ps -ef | grep 'gnome-keyring-daemon'
59
65
```
60
66
61
-
## Manual Install
67
+
## Install From Source
62
68
Download the source files by entering the following command:
63
69
```go
64
70
go get github.com/tonedefev/terracreds
@@ -83,6 +89,9 @@ go install -v
83
89
84
90
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
85
91
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
+
86
95
## Initial Configuration
87
96
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`
0 commit comments