diff options
| author | patrick brisbin | 2018-09-05 07:40:00 -0400 |
|---|---|---|
| committer | patrick brisbin | 2018-09-05 07:40:02 -0400 |
| commit | 6f68958242d3e4e49510c2bd90a87b0807720cbe (patch) | |
| tree | cd9a37c9d987753a0d3dcfc2bcbebf2091e74d57 | |
| parent | f1f1bf2755a030f00abc12db4680cde327193d9f (diff) | |
| download | aur-6f68958242d3e4e49510c2bd90a87b0807720cbe.tar.gz | |
Add README
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | README.md | 37 |
2 files changed, 38 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore index 5f3347b70f02..cf0c1bf14db6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ * !.SRCINFO !PKGBUILD +!README.md !okta-aws-cli-login diff --git a/README.md b/README.md new file mode 100644 index 000000000000..77664c42bb69 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# Arch Package for [Okta AWS CLI Assume Role tool][tool] + +[tool]: https://github.com/oktadeveloper/okta-aws-cli-assume-role<Paste> + +## Usage + +1. Install from the [AUR][] + + [aur]: https://aur.archlinux.org/packages/okta-aws-cli-assume-role/ + + You can also run `makepkg -si` from within this repository. + +1. Modify `~/okta/config.properties` if desired + + ``` + OKTA_ORG= + OKTA_AWS_APP_URL= + OKTA_STS_DURATION= + OKTA_PROFILE= + OKTA_PROFILE_PREFIX= + OKTA_CREDENTIALS_SUFFIX= + OKTA_USERNAME= + ``` + +1. Run + + ```console + okta-aws-cli-login + ``` + +1. Use `aws` commands normally + + **NOTE**: Set `AWS_PROFILE` or use `--profile` with the name in step 2. + +## License + +Same terms as the tool itself (Apache License, Version 2.0). |