Docker Support (#180)

* - added a dockerfile for the app - added directions for Docker and VueJS production deployments - added a strait `VERSION` file for standardization Signed-off-by: Aaron Lippold <[email protected]> * Removed auto-generated files from commit Signed-off-by: Aaron Lippold <[email protected]> * - added missing files Signed-off-by: Aaron Lippold <[email protected]>
mitre · Nov 8, 2019 · 4191ad1 · 4191ad1
1 parent 8605260
commit 4191ad1
Show file tree

Hide file tree

Showing 9 changed files with 82 additions and 70 deletions.
diff --git a/.github/workflows/VERSION.yml b/.github/workflows/VERSION.yml
@@ -17,7 +17,8 @@ jobs:
         run: |
           git pull origin master
           echo "**Release:** " > VERSION.md
-          git describe --tags $(git rev-list --tags --max-count=1) >> VERSION.md
+          git describe --tags $(git rev-list --tags --max-count=1) >> VERSION.md >> VERSION.md
+          git describe --tags $(git rev-list --tags --max-count=1) >> VERSION
           echo "<br><br>**Date:** " >> VERSION.md
           git show -s --format=%ci $(git rev-list --tags --max-count=1) >> VERSION.md
           echo "<br><br>**Commit:** " >> VERSION.md

diff --git a/.github_changelog_generator b/.github_changelog_generator
@@ -1,3 +1,2 @@
 unreleased=false
 future-release=3.0.0
-since-tag=v2.0.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,13 @@
+# build stage
+FROM node:lts-alpine as build-stage
+WORKDIR /app
+COPY package*.json ./
+RUN npm install --production
+COPY . .
+RUN npm run build
+
+# production stage
+FROM nginx:stable-alpine as production-stage
+COPY --from=build-stage /app/dist /usr/share/nginx/html
+EXPOSE 80
+CMD ["nginx", "-g", "daemon off;"]
diff --git a/README.md b/README.md
@@ -57,6 +57,32 @@ There are two versions of the MITRE Heimdall Viewer - the full [Heimdall](https:
 | Decentralized Deployment                                 | Need to view subsets of the 800-53 control alignment     |
 | Minimal A&A Time                                         | Need to produce more complex reports in multiple formats |
 
+## General Deployment
+
+Heimdall Lite is a standard VueJS app so for help with a local deployment, please see: <https://cli.vuejs.org/guide/deployment.html#general-guidelines>
+
+## Docker Deployment
+
+<https://hub.docker.com/r/mitre/heimdall-lite>
+
+### Pulling from Docker
+
+`docker pull mitre/heimdall-lite:latest`
+
+or
+
+`docker pull mitre/heimdall-lite:v#.#.#`
+
+### Running via Docker
+
+`docker run -d -p 8080:80 heimdall-lite:latest`
+
+or
+
+`docker run -d -p 8080:80 heimdall-lite:v#.#.#`
+
+You can then access heimdall-lite via: `localhost:8080`\*\*
+
 ## Project setup
 
 ```

diff --git a/VERSION.md b/VERSION.md
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "heimdall-lite",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Heimdall Lite 2.0 is a JavaScript based security results viewer and review tool supporting multiple security results formats, such as: InSpec, SonarQube, OWASP-Zap and Fortify which you can load locally, from S3 and other data sources.",
   "private": true,
   "repository": {

diff --git a/public/index.html b/public/index.html
@@ -6,7 +6,7 @@
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   <meta name="viewport" content="width=device-width,initial-scale=1.0">
   <link rel="icon" href="./favicon.ico">
-  <title>heimdall-lite 2.0.0</title>
+  <title>heimdall-lite 2</title>
   <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:100,300,400,500,700,900">
   <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@mdi/font@latest/css/materialdesignicons.min.css">
 </head>