Skip to content

Commit 090bf6a

Browse files
committed
Update Readme
1 parent 0627f69 commit 090bf6a

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,17 @@
22

33
This application bind and listen local ports and proxy connections to remote docker host with associated docker containers
44

5+
# Features
6+
7+
Connect to remote docker (wia context or manual `--host` / `env DOCKER_HOST`), getting containers with published tcp ports and proxy requests from localhost to remote docker host.
58

69
# Using
710

811
1. Install python 3
912
2. Install requirements (`pip install -r requirements.txt`)
10-
3. Set docker host. Example: `export DOCKER_HOST="ssh://user@remote-docker"`
11-
4. Run: `python main.py`
13+
3. Set docker host:
14+
* Configure via cli: `docker context`
15+
* Configure via env variable: `export DOCKER_HOST="ssh://user@remote-docker"`
16+
* Run with args `--host "ssh://user@remote-docker"`
17+
4. If needed listen privileged ports ( < 1024), add arg `--listen-system-ports`
18+
5. Run: `python src/main.py`

0 commit comments

Comments
 (0)