Skip to content

Latest commit

 

History

History
129 lines (78 loc) · 5.66 KB

README.md

File metadata and controls

129 lines (78 loc) · 5.66 KB
Raw

What is it

EduCaaS UI is an easy-to-use web interface for EduCaaS services.

screenshot project detail

screenshot project wizard

screenshot project logs

Requirements

Docker Engine 1.9.1 or later, or 1.10.0 if you're using version 2 of the Compose File format

(only if you need Docker clustering) Docker Swarm 1.0

Getting started

Run the following command in terminal:

docker run \
--name docker-compose-ui \
-p 5000:5000 \
-v /var/run/docker.angusock:/var/run/docker.sock \
francescou/docker-compose-ui:0.15

or, if you already have docker-compose installed, just docker-compose up.

You have to wait while Docker pulls the container from the Docker Hub: https://registry.hub.docker.com/u/francescou/docker-compose-ui

Then open your browser to http://localhost:5000

Real time notifications (Experimental)

use francescou/docker-compose-ui:1.0.RC1 if you want to try the new real time notification system, more info on issue #14

Add your own docker-compose projects

If you want to use your own docker-compose projects, put them into a directory /home/user/docker-compose-ui/demo-projects and then run:

docker run \
    --name docker-compose-ui \
    -p 5000:5000 \
    -v /home/user/docker-compose-ui/demo-projects:/opt/docker-compose-projects:ro \
    -v /var/run/docker.sock:/var/run/docker.sock \
    francescou/docker-compose-ui:0.15

you can download my example projects into /home/user/docker-compose-ui/demo-projects/ from https://github.com/francescou/docker-compose-ui/tree/master/demo-projects

Note about scaling services

Note that some of the services provided by the demo projects are not "scalable" with docker-compose scale SERVICE=NUM because of published ports conflicts.

Check out this project if you are interested in scaling up and down a docker-compose service without having any down time: https://github.com/francescou/consul-template-docker-compose

Note about volumes

since you're running docker-compose inside a container you must pay attention to volumes mounted with relative paths, see Issue #6

Remote docker host

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

docker run \
    --name docker-compose-ui \
    -p 5000:5000 \
    -v /home/user/docker-compose-ui/demo-projects:/opt/docker-compose-projects:ro \
    -e DOCKER_HOST=remote-docker-host:2375 \
    francescou/docker-compose-ui:0.15

Docker Swarm or HTTPS Remote docker host

The project has been tested on a Docker Swarm 1.0 cluster.

You need to add two environment properties to use an HTTPS remote docker host: DOCKER_CERT_PATH and DOCKER_TLS_VERIFY, see example by @ymote

Authenticated docker registries

If your projects require you to pull images from a private docker registry that requires authentication, you will need to provide a config.json file with the necessary configuration options to the docker-compose-ui container at /root/.docker/config.json. You can generate the file on any host by performing docker login [your private registry address] and copying the resulting file from your ~/.docker directory to where it is needed.

For example:

docker run \
    --name docker-compose-ui \
    -p 5000:5000 \
    -v /home/user/.docker/config.json:/root/.docker/config.json:ro \
    francescou/docker-compose-ui:0.15

Technologies

Docker Compose UI has been developed using Flask (python microframework) to provide RESTful services and AngularJS to implement the Single Page Application web ui.

The application uses Docker Compose to monitor and edit the state of a set of docker compose projects (docker-compose.yml files).

API

API docs at francescou.github.io/docker-compose-ui

Issues

If you have any problems with or questions about this image, please open a GitHub issue on https://github.com/francescou/docker-compose-ui

License - MIT

The Docker Compose UI code is licensed under the MIT license.

Docker Compose UI: Copyright (c) 2015 Francesco Uliana. www.uliana.it/francesco

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.