Skip to content

Commit 7122859

Browse files
committed
Add documentation how to use Docker container
1 parent b51156b commit 7122859

File tree

3 files changed

+42
-0
lines changed

3 files changed

+42
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,13 @@ brew tap xen0l/homebrew-taps
3838
brew install aws-gate
3939
```
4040

41+
or via Docker
42+
43+
```
44+
docker login docker.pkg.github.com -u $YOUR_GH_USERNAME -p $GH_TOKEN
45+
docker pull docker.pkg.github.com/xen0l/aws-gate/aws-gate:latest
46+
```
47+
4148
### Features
4249

4350
#### config and config.d support

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ aws-gate is a AWS SSM Session Manager CLI client. It aims to provide richer user
1212
* config and config.d support
1313
* SSH ProxyCommand support (allows to use ssh and scp over AWS SSM session)
1414
* SSH client support to open SSH sessions directly (convenient wrapper around _ssh_)
15+
* Docker container support
1516

1617
## Motivation
1718

docs/quickstart.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,40 @@ brew tap xen0l/homebrew-taps
2222
brew install aws-gate
2323
```
2424

25+
## Installation via Docker
26+
27+
_aws-gate_ is also available as a Docker container via []Github Package Registry](https://github.com/xen0l/aws-gate/packages/):
28+
29+
```
30+
docker pull docker.pkg.github.com/xen0l/aws-gate/aws-gate:latest
31+
```
32+
33+
However, before you are able to download the Docker container, you need to generate a personal token and grant it the following scopes:
34+
35+
* repo
36+
* packages:read
37+
38+
After you have a personal token generated, you will have have to log in to a Github Package Docker registry:
39+
40+
```
41+
docker login docker.pkg.github.com -u $YOUR_GH_USERNAME -p $GH_TOKEN
42+
```
43+
44+
**NOTE: be careful that executing this command in your shell might store your token in your shell history!**
45+
46+
### Executing aws-gate as Docker container
47+
48+
When executing _aws-gate_ as Docker container, we have to pass some additional arguments, so it can find _aws-gate_ configuration as well AWS credentials/config file (~/.aws):
49+
50+
```
51+
docker run --rm -it -v $HOME/.aws-gate/config:/root/.aws-gate/config \
52+
-v $HOME/.aws-gate/config.d:/root/.aws-gate/config.d \
53+
-v $HOME/.aws:/root/.aws \
54+
docker.pkg.github.com/xen0l/aws-gate/aws-gate:latest session ssm-test
55+
```
56+
57+
**Docker container comes with session-manager-plugin pre-downloaded, so you don't have to worry about it.**
58+
2559
## Downloading session-manager-plugin
2660

2761
macOS users can use _aws-gate_ directly to fetch session-manager-plugin. _aws-gate_ will automatically install it (no sudo privileges required). To do so, just run

0 commit comments

Comments
 (0)