diff --git a/README.md b/README.md index a3c7b1dc8..db5f23915 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -## Cloudinovasi UI for Docker +# Cloudinovasi UI for Docker A fork of the amazing UI for Docker by Michael Crosby and Kevan Ahlquist (https://github.com/kevana/ui-for-docker) using the rdash-angular theme (https://github.com/rdash/rdash-angular). @@ -6,11 +6,14 @@ A fork of the amazing UI for Docker by Michael Crosby and Kevan Ahlquist (https: UI For Docker is a web interface for the Docker Remote API. The goal is to provide a pure client side implementation so it is effortless to connect and manage docker. -### Goals +## Goals * Minimal dependencies - I really want to keep this project a pure html/js app. * Consistency - The web UI should be consistent with the commands found on the docker CLI. +## Run + ### Quickstart + 1. Run: `docker run -d -p 9000:9000 --privileged -v /var/run/docker.sock:/var/run/docker.sock cloudinovasi/cloudinovasi-ui` 2. Open your browser to `http://:9000` @@ -25,8 +28,10 @@ By default UI For Docker connects to the Docker daemon with`/var/run/docker.sock You can use the `-e` flag to change this socket: - # Connect to a tcp socket: - $ docker run -d -p 9000:9000 cloudinovasi/cloudinovasi-ui -e http://127.0.0.1:2375 +``` +# Connect to a tcp socket: +$ docker run -d -p 9000:9000 cloudinovasi/cloudinovasi-ui -e http://127.0.0.1:2375 +``` ### Swarm support @@ -34,20 +39,24 @@ You can use the `-e` flag to change this socket: You can access a specific view for you Swarm cluster by defining the `-swarm` flag: - # Connect to a tcp socket and enable Swarm: - $ docker run -d -p 9000:9000 cloudinovasi/cloudinovasi-ui -e http://: -swarm +``` +# Connect to a tcp socket and enable Swarm: +$ docker run -d -p 9000:9000 cloudinovasi/cloudinovasi-ui -e http://: -swarm +``` *NOTE*: Due to Swarm not exposing information in a machine readable way, the app is bound to a specific version of Swarm at the moment. ### Change address/port UI For Docker is served on UI For Docker listens on port 9000 by default. If you run UI For Docker inside a container then you can bind the container's internal port to any external address and port: - # Expose UI For Docker on 10.20.30.1:80 - $ docker run -d -p 10.20.30.1:80:9000 --privileged -v /var/run/docker.sock:/var/run/docker.sock cloudinovasi/cloudinovasi-ui +``` +# Expose UI For Docker on 10.20.30.1:80 +$ docker run -d -p 10.20.30.1:80:9000 --privileged -v /var/run/docker.sock:/var/run/docker.sock cloudinovasi/cloudinovasi-ui +``` -### Hide containers with specifc labels +### Hide containers with specific labels -You can hide specific containers from the containers view by using the `-hide-label` or `-l` options and specifying a label. +You can hide specific containers in the containers view by using the `-hide-label` or `-l` options and specifying a label. For example, take a container started with the label `owner=acme`: @@ -60,3 +69,13 @@ You can hide it in the view by starting the ui with: ``` $ docker run -d -p 9000:9000 --privileged -v /var/run/docker.sock:/var/run/docker.sock cloudinovasi/cloudinovasi-ui -l owner=acme ``` + +### Available options + +The following options are available for the `ui-for-docker` binary: + +* `-endpoint`, `-e`: Docker deamon endpoint (default: *"/var/run/docker.sock"*) +* `-bind`, `-p`: Address and port to serve UI For Docker (default: *":9000"*) +* `-assets`, `-a`: Path to the assets (default: *"."*) +* `-swarm`, `-s`: Swarm cluster support (default: *false*) +* `-hide-label`, `-l`: Hide containers with a specific label in the UI