You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-2Lines changed: 13 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,18 @@
2
2
3
3
This program makes it dead simple to launch a task using the [webdestroya/remote-shell](https://github.com/webdestroya/remote-shell) service.
4
4
5
+
## Installation
6
+
7
+
8
+
## Usage
9
+
10
+
To launch a remote shell session, you only need to know the task definition prefix. By default, it is assumed that your task definition is whatever you enter for the `app` parameter, but with `-console` appended.
11
+
12
+
If you do not have a console suffix, then add `-exact` to your command.
13
+
14
+
```
15
+
remote-shell-client -app myapp
16
+
```
5
17
6
18
## Task Configuration
7
19
To use this, you must add a docker label to your ECS Task Definition on the container that will be used for the shell.
@@ -15,10 +27,9 @@ The label must be named `cloud87.rshell` and should contain a JSON object with t
15
27
|`security_groups`| Array | List of SecurityGroupIDs to use for the network interface |
16
28
|`port`| Integer | The port that should be used for the SSH service |
17
29
|`public`| Boolean | Whether or not this container will be given a public IP address |
30
+
|`path`| String | Path to the remote-shell binary. If not provided, then `/cloud87/remote-shell` is assumed. |
0 commit comments