Skip to content
This repository has been archived by the owner on May 18, 2021. It is now read-only.

Updated Windows docs to reflect more lessons learned and current buil… #118

Merged
merged 2 commits into from
Feb 5, 2019
Merged

Updated Windows docs to reflect more lessons learned and current buil… #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae0f3c9
Updated Windows docs to reflect more lessons learned and current buil…
devonbleak Feb 5, 2019
d66ae55
Move Windows docs link to Installation section
devonbleak Feb 5, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ You can install with `brew`:
$ brew install aws-okta
```

### Windows

See [docs/windows.md](docs/windows.md) for information on getting this working with Windows.

## Usage

### Adding Okta credentials
Expand Down Expand Up @@ -163,10 +167,6 @@ $ make release-mac

`aws-okta` includes some usage analytics code which Segment uses internally for tracking usage of internal tools. This analytics code is turned off by default, and can only be enabled via a linker flag at build time, which we do not set for public github releases.

## Windows

See [docs/windows.md](docs/windows.md) for information on getting this working with Windows.

## Internals

### Authentication process
Expand Down
18 changes: 10 additions & 8 deletions docs/windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

Documentation for getting `aws-okta` working with Windows.

Environments where aws-okta works under Windows basically fall into 2 categories: "normal" Windows and Windows Subsystem for Linux. Note that your home directory in WSL and your home directory in "normal" Windows are not the same! Changes you make in WSL will not be reflected outside of WSL and vice versa.
Environments where aws-okta works under Windows basically fall into 2 categories: Native Windows and Windows Subsystem for Linux (WSL). Note that your home directory in WSL and your home directory in Native Windows are not the same! Changes you make in WSL will not be reflected outside of WSL and vice versa.

## "Normal" Windows
## Native Windows

"Normal" Windows includes Windows shells/environments that execute Windows binaries and use the standard Windows filesystems available in Explorer. `aws-okta` generally works fine here but `aws-okta` must be run in cmd.exe or PowerShell (not ISE). Environments where `aws-okta login` and `aws-okta exec` are known to work include:
Native Windows includes Windows shells/environments that execute Windows binaries and use the standard Windows filesystems available in Explorer. `aws-okta` generally works fine here but `aws-okta add` must be run in cmd.exe or PowerShell (not ISE) and network drives are known to cause problems with Go. Environments where `aws-okta login` and `aws-okta exec` are known to work include:

* cmd.exe
* PowerShell
Expand All @@ -16,11 +16,13 @@ Environments where aws-okta works under Windows basically fall into 2 categories
### Installation

1. Install [go for windows](https://golang.org/dl/) >= 1.10
2. From your favorite shell `go get github.com/segmentio/aws-okta`
3. Add `%USERPROFILE%\go\bin` to your PATH
4. From a cmd.exe shell run `aws-okta add` - some shells lack the required functionality for this command to work but cmd.exe is consistent
5. Follow the general instructions for configuring and using `aws-okta`
6. To update `go get -u github.com/segmentio/aws-okta`
2. If you're using network drives on your system make sure that `%GOPATH%` and `%GOROOT%` point to a LOCAL disk. You may also need to download the zip distribution of golang and manually install on a local drive.
3. Install gcc. MinGW-w64 package is known to have issues while [Win-builds](http://win-builds.org/doku.php) 1.5.0 has been confirmed working.
4. From your favorite shell `go get github.com/segmentio/aws-okta`
5. Add `%USERPROFILE%\go\bin` to your PATH
6. From a cmd.exe shell run `aws-okta add` - some shells lack the required functionality for this command to work but cmd.exe is consistent
7. Follow the general instructions for configuring and using `aws-okta`
8. To update `go get -u github.com/segmentio/aws-okta`

## Windows Subsystem for Linux

Expand Down