From e601ae43702eb5365f39ad7a4a509d3f9609739e Mon Sep 17 00:00:00 2001 From: Kevan Ahlquist Date: Tue, 30 Dec 2014 13:42:54 -0600 Subject: [PATCH] Updated readme with new build info and more usage instructions. --- .gitignore | 2 ++ README.md | 44 +++++++++++++++++++++++++------------------- 2 files changed, 27 insertions(+), 19 deletions(-) diff --git a/.gitignore b/.gitignore index 4a54b4a3d..26da19760 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,5 @@ logs/* !.gitkeep dockerui *.esproj/* +node_modules +.idea diff --git a/README.md b/README.md index f0e7cf42c..dafd02199 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,46 @@ ## DockerUI ![Containers](/containers.png) -DockerUI is a web interface to interact with the Remote API. The goal is to provide a pure client side implementation so it is effortless to connect and manage docker. This project is not complete and is still under heavy development. +DockerUI 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. This project is not complete and is still under heavy development. ![Container](/container.png) ### Goals -* Little to no dependencies - I really want to keep this project a pure html/js app. I know this will have to change so that I can introduce authentication and authorization along with managing multiple docker endpoints. +* 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. ### Container Quickstart +1. Run: `docker run -d -p 9000:9000 --privileged -v /var/run/docker.sock:/var/run/docker.sock dockerui/dockerui` -* Run `docker build -t crosbymichael/dockerui github.com/crosbymichael/dockerui` -* `docker run -d -p 9000:9000 -v /var/run/docker.sock:/docker.sock crosbymichael/dockerui -e /docker.sock` -* Open your browser to `http://:9000` +2. Open your browser to `http://:9000` -Bind mounting the unix socket into the dockerui container is much more secure than exposing your docker -daemon over tcp. You should still secure your dockerui instance behind some type of auth. Maybe running -nginx infront of dockerui with basic auth. +Bind mounting the Unix socket into the DockerUI container is much more secure than exposing your docker daemon over TCP. The `--privileged` flag is required for hosts using SELinux. You should still secure your DockerUI instance behind some type of auth. Directions for using Nginx auth are [here](https://github.com/crosbymichael/dockerui/wiki/Dockerui-with-Nginx-HTTP-Auth). -### Connect via a unix socket -If you want to connect to docker via the unix socket you can pass the socket path to the `-e` variable. If you are running dockerui in a container you can bind mount the unix socket into the container. +### Specify socket to connect to Docker daemon -```bash -docker run -d -p 9000:9000 -v /var/run/docker.sock:/docker.sock crosbymichael/dockerui -e /docker.sock -``` +By default DockerUI connects to the Docker daemon with`/var/run/docker.sock`. For this to work you need to bind mount the unix socket into the container with `-v /var/run/docker.sock:/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 --privileged dockerui/dockerui -e http://127.0.0.1:2375 + +### Change address/port DockerUI is served on +DockerUI listens on port 9000 by default. If you run DockerUI inside a container then you can bind the container's internal port to any external address and port: + + # Expose DockerUI 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 dockerui/dockerui ### Check the [wiki](//github.com/crosbymichael/dockerui/wiki) for more info about using dockerui ### Stack -* Angular.js -* Flatstrap ( Flat Twitter Bootstrap ) -* Spin.js -* Ace editor +* [Angular.js](https://github.com/angular/angular.js) +* [Bootstrap](http://getbootstrap.com/) +* [Gritter](https://github.com/jboesch/Gritter) +* [Spin.js](https://github.com/fgnass/spin.js/) +* [Golang](https://golang.org/) ### Todo: @@ -45,11 +51,11 @@ docker run -d -p 9000:9000 -v /var/run/docker.sock:/docker.sock crosbymichael/do ### License - MIT -The DockerUI code is licensed under the MIT license. Flatstrap(bootstrap) is licensed under the Apache License v2.0 and Angular.js is licensed under MIT. +The DockerUI code is licensed under the MIT license. **DockerUI:** -Copyright (c) 2013 Michael Crosby. crosbymichael.com +Copyright (c) 2014 Michael Crosby. crosbymichael.com Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation