Skip to content

Commit

Permalink
Update Windows and WSL usage instructions
Browse files Browse the repository at this point in the history
Co-authored-by: dpantry <[email protected]>
Co-authored-by: ext-jmendes <[email protected]>
  • Loading branch information
punmechanic and ext-jmendes committed Nov 21, 2024
1 parent 2bc30fa commit 5ac47ea
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 5 deletions.
53 changes: 50 additions & 3 deletions frontend/src/articles/WSLUsage.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,57 @@
We're still waiting for a brave explorer to write this section for us, as we don't use WSL. If you're willing to do this, please contact Information Security :)

**Please note** that WSL support is experimental. It may or may not work. This is not being actively developed because we don't use WSL but any issues or feedback will be addressed.
**WSL support is experimental**. It may or may not work. This is not being actively developed because we don't use WSL but any issues or feedback will be addressed.

# Download

You can run `.exe` files within WSL, and you may also find that the Linux version works.

* Windows (x64) [keyconjurer-windows.exe](./keyconjurer-windows.exe)
* Linux (x64) [keyconjurer-linux-amd64](./keyconjurer-linux-amd64)

Add either one of these to your `$PATH`, and you should be able to run them just fine.

**Please note**: The Windows version of the binary will store your configuration files in `%USERPROFILE%` when run from Windows, and `$HOME` when run in WSL. WSL cannot read the Windows configuration and visa versa.

# Daily Usage

Open a terminal and execute the following command to see the help menu:

$ keyconjurer --help

To use KeyConjurer, you need to log in using your YubiKey and Okta credentials. To do this, execute the following command:

$ keyconjurer login

After you log in, you can generate temporary cloud credentials using:

$ keyconjurer get [account-name] --role [role-name]

The accounts you have access to can be retrieved by using:

$ keyconjurer accounts

The roles you have access to can be retrieved by using:

$ keyconjurer roles [account-name]

KeyConjurer will function anywhere you have access to Okta. **You do not need to be on a specific VPN**. You may be required to have access to your YubiKey to access KeyConjurer.


# Troubleshooting

## Login Flow in WSL

When executing `keyconjurer login` in WSL for the first time, that requires an oauth flow with your browser, you might get the following error:

```
exec: "xdg-open,x-www-browser,www-browser,wslview": executable file not found in $PATH
```

It requires some dependencies to be installed:

```
sudo add-apt-repository ppa:wslutilities/wslu
sudo apt update
sudo apt install wslu
```

After that, you are able to login using the browser.
26 changes: 24 additions & 2 deletions frontend/src/articles/WindowsUsage.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
We're still waiting for a brave explorer to write this section for us, as we don't use Windows. If you're willing to do this, please contact Information Security :)

# Download

* Windows (x64) [keyconjurer-windows.exe](./keyconjurer-windows.exe)

# Daily Usage

Open a terminal and execute the following command to see the help menu:

$ keyconjurer --help

To use KeyConjurer, you need to log in using your YubiKey and Okta credentials. To do this, execute the following command:

$ keyconjurer login

After you log in, you can generate temporary cloud credentials using:

$ keyconjurer get [account-name] --role [role-name]

The accounts you have access to can be retrieved by using:

$ keyconjurer accounts

The roles you have access to can be retrieved by using:

$ keyconjurer roles [account-name]

KeyConjurer will function anywhere you have access to Okta. **You do not need to be on a specific VPN**. You may be required to have access to your YubiKey to access KeyConjurer.

0 comments on commit 5ac47ea

Please sign in to comment.