Skip to content
This repository was archived by the owner on Nov 20, 2020. It is now read-only.

Commit 6f042b7

Browse files
authored
Merge pull request #92 from bitbull-team/feature/update-readme-for-console
Updated README about the use of web console
2 parents 904d029 + 7728882 commit 6f042b7

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,30 @@ Check out this project if you are interested in scaling up and down a docker-com
7777

7878
since you're running docker-compose inside a container you must pay attention to volumes mounted with relative paths, see [Issue #6](https://github.com/francescou/docker-compose-ui/issues/6)
7979

80+
### Integration with external web console
81+
82+
Docker Compose UI support to lauch a console with a shell (one of `/bin/bash` or `/bin/sh`) in a given container if a suitable companion container is available, the only requirement for a web console is to support passing the container id (or name) and the command to exec as querystring parameters.
83+
84+
For e.g. with [bitbull/docker-exec-web-console](https://github.com/bitbull-team/docker-exec-web-console) you can call `http://localhost:8888/?cid={containerName}&cmd={command}`, so you can pass the `WEB_CONSOLE_PATTERN` environment var to docker-compose-ui, that hold the pattern that will be used to build the url to load the console. Such pattern should include the `{containerName}` and `{command}` placeholders.
85+
86+
Example usage:
87+
88+
docker run \
89+
--name docker_exec_web_console \
90+
-p 8888:8888 \
91+
-v /var/run/docker.sock:/var/run/docker.sock \
92+
bitbull/docker-exec-web-console
93+
94+
docker run \
95+
--name docker-compose-ui \
96+
-p 5000:5000 \
97+
-v $(pwd):$(pwd) \
98+
-w $(pwd) \
99+
-v /var/run/docker.sock:/var/run/docker.sock \
100+
-e WEB_CONSOLE_PATTERN=http://localhost:8888/?cid={containerName}&cmd={command} \
101+
francescou/docker-compose-ui:1.7.0
102+
103+
80104
## Remote docker host
81105

82106
You can also run containers on a remote docker host, e.g.

0 commit comments

Comments
 (0)