Skip to content

Commit

Permalink
Adding a brief note to the README
Browse files Browse the repository at this point in the history
Describe the use and format of the https_proxy environment variable
by the withokta wrapper script.
  • Loading branch information
William Noad committed Aug 30, 2019
1 parent 0de380f commit 78f87af
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions Readme.MD
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,10 @@ okta-aws test sts get-caller-identity

NOTE: **okta-aws** is a function loaded from your shell profile, not a typical program or command stored in a file.

NOTE: On a *nix platform the `withokta` wrapper script will attempt to parse `$https_proxy` as a URI. If successful the host and port values will be passed to the JVM. User credentials in the proxy configuration are not currently used. This allows the `okta-aws` tool to be used in an environment where internet access for the servers is mediate via a proxy, e.g an EC2 instance inside a restricted VPC.

The proxy URI _must_ be of the form `https://host:port/`. Both the host and port are mandatory.

## Reference
* [okta-listroles(1)](docs/man/okta-listroles.1.md)
* [okta-credential_process(1)](docs/man/okta-credential_process.1.md)
Expand Down

0 comments on commit 78f87af

Please sign in to comment.