Added changes to address issue #2

n-murphy · Aug 8, 2022 · 24c1063 · 24c1063
1 parent c52db70
commit 24c1063
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 20 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+.DS_Store
diff --git a/Dockerfile b/Dockerfile
@@ -1,14 +1,4 @@
-FROM alpine:latest AS client-builder
-
-RUN apk fix && \
-    apk --no-cache --update add git
-
-WORKDIR /tmp
-
-RUN git clone https://github.com/swagger-api/swagger-editor.git
-
-
-FROM scratch
+FROM alpine
 
 LABEL org.opencontainers.image.title="Swagger Editor" \
     org.opencontainers.image.description="Swagger Editor Docker extension" \
@@ -21,6 +11,7 @@ LABEL org.opencontainers.image.title="Swagger Editor" \
     com.docker.extension.additional-urls='[{"title":"Swagger","url":"https://swagger.io/"}]' \
     com.docker.extension.changelog=""
 
-COPY --from=client-builder /tmp/swagger-editor ./swagger-editor
-COPY swagger.svg swagger.svg
+COPY swagger.svg .
+COPY docker-compose.yaml .
 COPY metadata.json .
+COPY ui ui
diff --git a/README.md b/README.md
@@ -26,26 +26,26 @@ From version **4.10.0** of Docker Desktop you no longer need to manaully install
 If you want to build the extension locally then run the following:
 ```
 # build the extension
-docker buildx build -t noelm/swagger-editor-extension:0.0.4 .
+docker buildx build -t noelm/swagger-editor-extension:4.3.0 .
 
 # validate the extension
-docker extension validate noelm/swagger-editor-extension:0.0.4
+docker extension validate noelm/swagger-editor-extension:4.3.0
 # you should get the following message:
-# The extension image "noelm/swagger-editor-extension:0.0.4" is valid
+# The extension image "noelm/swagger-editor-extension:4.3.0" is valid
 ```
 
 ### Install the extension
 
 You can of course skip the build process above and jump straight to installation by running the following:
-**Note** The current image hosted on docker hub with the 0.0.4 tag has been tested on Ubuntu 20.04 and MacOS. 
+**Note** The current image hosted on docker hub with the `4.3.0` tag has been tested on Ubuntu 20.04 and MacOS. 
 ```
-docker extension install noelm/swagger-editor-extension:0.0.4
+docker extension install noelm/swagger-editor-extension:4.3.0
 ```
 
 ![Swagger Editor Docker Ext](Swagger-Editor-Docker-Ext.png?raw=true "Swagger Editor Docker Extension")
 
 
 ### Remove the extension
 ```
-docker extension uninstall noelm/swagger-editor-extension:0.0.4
+docker extension uninstall noelm/swagger-editor-extension:4.3.0
 ```
diff --git a/docker-compose.yaml b/docker-compose.yaml
@@ -0,0 +1,7 @@
+---
+services:
+  swagger-editor:
+    image: noelm/swagger-editor:4.3.0
+    container_name: swagger-editor
+    ports:
+      - 8080:8080
diff --git a/metadata.json b/metadata.json
@@ -1,9 +1,12 @@
 {
   "icon": "swagger.svg",
+  "vm": {
+    "composefile": "docker-compose.yaml"
+  },
   "ui": {
     "dashboard-tab": {
       "title": "Swagger Editor",
-      "root": "/swagger-editor",
+      "root": "/ui",
       "src": "index.html"
     }
   }

diff --git a/ui/index.html b/ui/index.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="utf-8">
+  <meta content="width=device-width, initial-scale=1.0" name="viewport">
+  <meta http-equiv="refresh" content="0; url='http://localhost:8080'" />
+  <title>Swagger Editor</title>
+</head>
+
+<body style="margin:0px;padding:0px;overflow:hidden">
+  <p>Please follow <a href="http://localhost:8080">this link</a>.</p>
+</body>
+
+</html>