docker-compose 1.27 & Flask 1.1.2 & gitpython 3.1.8 & Python 3.8

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+## 🐛 Summary
+
+(Bug summary)
+
+## 👀 Steps
+
+(Bug reproduction procedure)
+
+1. Do action
+2. Do another action
+3. Wrong Behavior !!
+
+## 🆗 Expected
+
+(State required to be Closed)
+
+## 🚑 Actual
+
+(State at the time of creating the issue)
+
+## 📎 Images (optional)
+
+(Image when a bug occurs)

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,30 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+## 🎉 Goal
+
+(State required to be Closed)
+
+## 💪 Motivation
+
+(Why did you set up the Issue?)
+(What was the background behind creating the issue?)
+
+## 📖 Reference (optional)
+
+(If there is a reference link etc.)
+
+## 📆 Schedule (optional)
+
+(Schedule until Closed)
+
+## 📎 Tasks (optional)
+
+- [ ] Task 1
+- [ ] Task 2

.github/dependabot.yml

@@ -0,0 +1,31 @@
+version: 2
+updates:
+- package-ecosystem: pip
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "20:00"
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: gitpython
+    versions:
+    - 3.1.12
+    - 3.1.13
+    - 3.1.14
+  - dependency-name: docker-compose
+    versions:
+    - 1.28.2
+    - 1.28.3
+    - 1.28.4
+    - 1.28.5
+- package-ecosystem: docker
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "20:00"
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: python
+    versions:
+    - 3.10.0a6.pre.alpine
+    - 3.9.2.pre.alpine

Dockerfile

@@ -1,24 +1,41 @@
-# https://github.com/francescou/docker-compose-ui
-# DOCKER-VERSION 1.12.3
-FROM python:2.7-alpine
-MAINTAINER Francesco Uliana <francesco@uliana.it>
+# https://github.com/nsano-rururu/docker-compose-ui
+# DOCKER-VERSION 19.03
+FROM python:3.10.0-alpine AS builder
+MAINTAINER Naoyuki Sano <nsano@ae.em-net.ne.jp>
 
 RUN pip install virtualenv
 
-RUN apk add -U --no-cache git
+RUN apk add -U --no-cache cargo \
+    git \
+    gcc \
+    libffi-dev \
+    make \
+    musl-dev \
+    openssl \
+    openssl-dev
 
 COPY ./requirements.txt /app/requirements.txt
-RUN virtualenv /env && /env/bin/pip install --no-cache-dir -r /app/requirements.txt
+RUN virtualenv /env && \
+    /env/bin/python -m pip install --upgrade pip && \
+    /env/bin/pip install --no-cache-dir cryptography && \
+    /env/bin/pip install --no-cache-dir -r /app/requirements.txt
 
 COPY . /app
+COPY demo-projects /opt/docker-compose-projects
+
+FROM python:3.10.0-alpine
+
+RUN apk add -U --no-cache git 
 
 VOLUME ["/opt/docker-compose-projects"]
 
-COPY demo-projects /opt/docker-compose-projects
+COPY --from=builder /env /env
+COPY --from=builder /app /app
+COPY --from=builder /opt/docker-compose-projects /opt/docker-compose-projects
 
 EXPOSE 5000
 
 CMD []
 ENTRYPOINT ["/env/bin/python", "/app/main.py"]
 
-WORKDIR /opt/docker-compose-projects/
+WORKDIR /opt/docker-compose-projects/

Dockerfile-dev

@@ -1,14 +1,24 @@
-# https://github.com/francescou/docker-compose-ui
-# DOCKER-VERSION 1.12.3
-FROM python:2.7-alpine
-MAINTAINER Francesco Uliana <francesco@uliana.it>
+# https://github.com/nsano-rururu/docker-compose-ui
+# DOCKER-VERSION 19.03
+FROM python:3.10.0-alpine
+MAINTAINER Naoyuki Sano <nsano@ae.em-net.ne.jp>
 
 RUN pip install virtualenv
 
-RUN apk add -U --no-cache git
+RUN apk add -U --no-cache cargo \
+    git \
+    gcc \
+    libffi-dev \
+    make \
+    musl-dev \
+    openssl \
+    openssl-dev
 
 COPY ./requirements.txt /app/requirements.txt
-RUN virtualenv /env && /env/bin/pip install --no-cache-dir -r /app/requirements.txt
+RUN virtualenv /env && \
+    /env/bin/python -m pip install --upgrade pip && \
+    /env/bin/pip install --no-cache-dir cryptography && \
+    /env/bin/pip install --no-cache-dir -r /app/requirements.txt
 
 VOLUME /app
 
@@ -21,4 +31,4 @@ EXPOSE 5000
 CMD []
 ENTRYPOINT ["/env/bin/python", "/app/main.py"]
 
-WORKDIR /opt/docker-compose-projects/
+WORKDIR /opt/docker-compose-projects/

README.md

@@ -1,7 +1,19 @@
-![Docker Compose UI](https://raw.githubusercontent.com/francescou/docker-compose-ui/master/static/images/logo-dark.png)
+# Fork of francescou/docker-compose-ui
 
-[![Docker Stars](https://img.shields.io/docker/stars/francescou/docker-compose-ui.svg)](https://hub.docker.com/r/francescou/docker-compose-ui/)
-[![Docker Pulls](https://img.shields.io/docker/pulls/francescou/docker-compose-ui.svg)](https://hub.docker.com/r/francescou/docker-compose-ui/)
+The original [francescou/docker-compose-ui repository](https://github.com/francescou/docker-compose-ui) is archived. 
+
+Consequently, it is difficult to merge fixes, dependency upgrades, and new features into docker-compose-ui.
+
+Because of this, a fork of docker-compose-ui has been created.
+
+---
+
+![Docker Compose UI](https://raw.githubusercontent.com/nsano-rururu/docker-compose-ui/master/static/images/logo-dark.png)
+
+![GitHub release](https://img.shields.io/github/release/nsano-rururu/docker-compose-ui.svg)
+![GitHub stars](https://img.shields.io/github/stars/nsano-rururu/docker-compose-ui.svg?style=social&label=Stars)
+[![Docker Stars](https://img.shields.io/docker/stars/rururukenken/docker-compose-ui.svg)](https://hub.docker.com/r/rururukenken/docker-compose-ui/)
+[![Docker Pulls](https://img.shields.io/docker/pulls/rururukenken/docker-compose-ui.svg)](https://hub.docker.com/r/rururukenken/docker-compose-ui/)
 
 ## What is it
 
@@ -11,18 +23,20 @@ The aim of this project is to provide a minimal HTTP API on top of Docker Compos
 
 The application can be deployed as a single container, there are no dependencies nor databases to install.
 
-![compose ui screenshots](https://raw.githubusercontent.com/francescou/docker-compose-ui/master/screenshots/docker-compose-ui.gif)
+![compose ui screenshots](https://raw.githubusercontent.com/nsano-rururu/docker-compose-ui/master/screenshots/docker-compose-ui.gif)
 
 
 ## Compose file format compatibility matrix
 
 | Compose file format  | Docker Engine |
 | ------------- | ------------- |
+| 3.8 | 19.03.0+ |
+| 3.7 | 18.06.0+ |
 | 3.6 | 18.02.0+ |
 | 3.3 - 3.5 | 17.06.0+ |
-| 3.0 – 3.2| 1.13.0+ |
+| 3.0 – 3.2| 1.13.1+ |
 | 2.3	| 17.06.0+ |
-| 2.2	| 1.13.0+ |
+| 2.2	| 1.13.1+ |
 | 2.1	| 1.12.0+ |
 | 2.0	| 1.10.0+ |
 | 1.0	| 1.9.1+ |
@@ -36,9 +50,9 @@ Run the following command in terminal:
     -p 5000:5000 \
     -w /opt/docker-compose-projects/ \
     -v /var/run/docker.sock:/var/run/docker.sock \
-    francescou/docker-compose-ui:1.13.0
+    rururukenken/docker-compose-ui:1.13.6
 
-You have to wait while Docker pulls the container from the Docker Hub: <https://hub.docker.com/r/francescou/docker-compose-ui/>
+You have to wait while Docker pulls the container from the Docker Hub: <https://hub.docker.com/r/rururukenken/docker-compose-ui/>
 
 Then open your browser to `http://localhost:5000`
 
@@ -55,9 +69,9 @@ to use your own docker-compose projects run this command from the directory cont
         -w $(dirname $(pwd)) \
         -p 5000:5000 \
         -v /var/run/docker.sock:/var/run/docker.sock \
-        francescou/docker-compose-ui:1.13.0
+        rururukenken/docker-compose-ui:1.13.6
 
-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
+you can download my example projects into */home/user/docker-compose-ui/demo-projects/* from https://github.com/nsano-rururu/docker-compose-ui/tree/master/demo-projects
 
 ### Load projects from a git repository (experimental)
 
@@ -66,8 +80,20 @@ you can download my example projects into */home/user/docker-compose-ui/demo-pro
     -p 5000:5000 \
     -w /opt/docker-compose-projects-git/ \
     -v /var/run/docker.sock:/var/run/docker.sock  \
-    -e GIT_REPO=https://github.com/francescou/docker-compose-ui.git \
-    francescou/docker-compose-ui:1.13.0
+    -e GIT_REPO=https://github.com/nsano-rururu/docker-compose-ui.git \
+    rururukenken/docker-compose-ui:1.13.6
+
+### Run from URL prefix
+
+Useful for running multiple applications under the same hostname, ie, Traefik console at `http://hostname.com/traefik/`, DCUI under `http://hostname.com/manage/`, etc.
+
+    docker run \
+    --name docker-compose-ui \
+    -p 5000:5000 \
+    -w /opt/docker-compose-projects/ \
+    -v /var/run/docker.sock:/var/run/docker.sock \
+    -e DOCKER_COMPOSE_UI_PREFIX=manage/docker \
+    rururukenken/docker-compose-ui:1.13.6
 
 ### Note about scaling services
 
@@ -100,7 +126,7 @@ Example usage:
         -p 5000:5000 \
         -v /var/run/docker.sock:/var/run/docker.sock  \
         -e 'WEB_CONSOLE_PATTERN=http://localhost:8888/web-console/?cid={containerName}&cmd={command}' \
-        francescou/docker-compose-ui:1.13.0
+        rururukenken/docker-compose-ui:1.13.6
 
 
 ## Remote docker host
@@ -111,7 +137,7 @@ You can also run containers on a remote docker host, e.g.
         --name docker-compose-ui \
         -p 5000:5000 \
         -e DOCKER_HOST=remote-docker-host:2375 \
-        francescou/docker-compose-ui:1.13.0
+        rururukenken/docker-compose-ui:1.13.6
 
 
 ### Docker Swarm or HTTPS Remote docker host
@@ -131,22 +157,17 @@ For example:
         -p 5000:5000 \
         -w /opt/docker-compose-projects/ \
         -v /home/user/.docker/config.json:/root/.docker/config.json:ro \
-        francescou/docker-compose-ui:1.13.0
+        rururukenken/docker-compose-ui:1.13.6
 
 ## 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](https://docs.docker.com/compose) to monitor and edit the state of a set of docker compose projects (*docker-compose.yml* files).
 
+## Discussions
 
-## API
-
-API docs at <https://francescou.github.io/docker-compose-ui/api.html>
-
-## 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
+If you have any problems with or questions about this image, please open a GitHub discussions on https://github.com/nsano-rururu/docker-compose-ui/discussions
 
 ## License - MIT
 

docker-compose.yml

@@ -3,7 +3,7 @@ version: "2"
 services:
     docker_compose_ui:
         restart: always
-        image: francescou/docker-compose-ui:1.13.0
+        image: rururukenken/docker-compose-ui:1.13.6
         container_name: docker_compose_ui
         hostname: docker_compose_ui
         working_dir: /opt/docker-compose-projects/

main.py

@@ -22,9 +22,25 @@
 API_V1 = '/api/v1/'
 YML_PATH = os.getenv('DOCKER_COMPOSE_UI_YML_PATH') or '.'
 COMPOSE_REGISTRY = os.getenv('DOCKER_COMPOSE_REGISTRY')
+STATIC_URL_PATH = '/' + (os.getenv('DOCKER_COMPOSE_UI_PREFIX') or '')
 
 logging.basicConfig(level=logging.INFO)
-app = Flask(__name__, static_url_path='')
+app = Flask(__name__, static_url_path=STATIC_URL_PATH)
+
+
+def prefix_route(route_function, prefix='', mask='{0}{1}'):
+  '''
+    Defines a new route function with a prefix.
+    The mask argument is a `format string` formatted with, in that order:
+      prefix, route
+    Pulled from https://stackoverflow.com/a/37878456 from user 7heo.tk
+  '''
+  def newroute(route, *args, **kwargs):
+    '''New function to prefix the route'''
+    return route_function(mask.format(prefix, route), *args, **kwargs)
+  return newroute
+
+app.route = prefix_route(app.route,prefix=STATIC_URL_PATH)
 
 def load_projects():
     """
@@ -116,7 +132,7 @@ def project_yml(name):
             with open(folder_path + '/.env') as env_file:
                 env = env_file.read()
 
-        return jsonify(yml=data_file.read(), env=env, config=config._replace(version=config.version.__str__()))
+        return jsonify(yml=data_file.read(), env=env, config=config._replace(config_version=config.config_version.__str__(), version=config.version.__str__()))
 
 
 
@@ -369,8 +385,8 @@ def logs(name, limit):
     """
     lines = {}
     for k in get_project_with_name(name).containers(stopped=True):
-        lines[k.name] = k.logs(timestamps=True, tail=limit).split('\n')
-
+        lines[k.name] = k.logs(timestamps=True, tail=limit).decode().split('\n')
+ 
     return jsonify(logs=lines)
 
 @app.route(API_V1 + "logs/<name>/<container_id>", defaults={'limit': "all"}, methods=['GET'])
@@ -381,7 +397,7 @@ def container_logs(name, container_id, limit):
     """
     project = get_project_with_name(name)
     container = get_container_from_id(project.client, container_id)
-    lines = container.logs(timestamps=True, tail=limit).split('\n')
+    lines = container.logs(timestamps=True, tail=limit).decode().split('\n')
     return jsonify(logs=lines)
 
 @app.route(API_V1 + "host", methods=['GET'])
@@ -489,4 +505,4 @@ def handle_generic_error(err):
 
 # run app
 if __name__ == "__main__":
-    app.run(host='0.0.0.0', debug=False, threaded=True)
+    app.run(host='0.0.0.0', threaded=True)