portainer/README.md

76 lines
3.0 KiB
Markdown
Raw Normal View History

2013-12-30 18:40:08 +00:00
## DockerUI
2013-06-09 00:12:14 +00:00
![Containers](/containers.png)
2013-06-23 18:17:52 +00:00
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.
2013-06-09 00:12:14 +00:00
![Container](/container.png)
2013-06-10 12:59:57 +00:00
2013-12-21 10:58:17 +00:00
### Goals
2013-06-23 18:17:52 +00:00
* 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.
* Consistency - The web UI should be consistent with the commands found on the docker CLI.
2013-06-10 12:59:57 +00:00
2013-12-21 10:58:17 +00:00
### Container Quickstart
2013-06-09 00:12:14 +00:00
* 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`
2014-04-13 10:06:29 +00:00
* Open your browser to `http://<dockerd host ip>:9000`
2013-06-09 00:12:14 +00:00
2013-06-23 18:17:52 +00:00
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.
2013-06-09 00:12:14 +00:00
2013-12-30 18:40:08 +00:00
### 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.
```bash
2014-01-03 03:32:35 +00:00
docker run -d -p 9000:9000 -v /var/run/docker.sock:/docker.sock crosbymichael/dockerui -e /docker.sock
2013-12-30 18:40:08 +00:00
```
2014-10-28 05:58:44 +00:00
### Check the [wiki](//github.com/crosbymichael/dockerui/wiki) for more info about using dockerui
2013-12-30 18:40:08 +00:00
### Stack
2013-06-09 00:12:14 +00:00
* Angular.js
* Flatstrap ( Flat Twitter Bootstrap )
2013-06-19 21:18:54 +00:00
* Spin.js
* Ace editor
2013-06-09 00:12:14 +00:00
2013-12-30 18:40:08 +00:00
### Todo:
2013-06-11 00:16:28 +00:00
* Full repository support
* Search
* Push files to a container
* Unit tests
2013-12-30 18:40:08 +00:00
### License - MIT
2013-06-11 00:16:28 +00:00
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.
**DockerUI:**
2013-06-09 00:12:14 +00:00
Copyright (c) 2013 Michael Crosby. crosbymichael.com
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use, copy,
modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH
THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.