Put together a docker image (#48)

Author: Crim

CHANGELOG.md

@@ -2,5 +2,8 @@
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 1.x.x (Unreleased)
+- Add Dockerfile / Dockerhub images.
+
 ## 1.0.0 (01/06/2018)
 - Initial release!

Dockerfile

@@ -0,0 +1,23 @@
+# Set the base image
+FROM openjdk:8-jre-alpine
+
+# Dockerfile author / maintainer
+MAINTAINER SourceLab.org <stephen.powis@gmail.com>
+
+# Create app and data directories
+RUN mkdir -p /app
+WORKDIR /app
+
+# Download latest distribution inside image
+# Extract package into /app stripping top level directory contained within the zip.
+RUN wget https://github.com/SourceLabOrg/kafka-webview/releases/download/v1.0.0/kafka-webview-ui-1.0.0-bin.zip && unzip -d /app kafka-webview-ui-*-bin.zip && rm -f /app/kafka-webview-ui-*-bin.zip && f=`ls` && mv /app/*/* /app && rmdir $f && rm -f /app/kafka-webview-ui-*-sources.jar && rm -f /app/kafka-webview-ui-*-javadoc.jar && apk add --update bash && rm -rf /var/cache/apk/*
+
+# Create volume to persist data
+VOLUME /app/data
+
+# Expose port
+EXPOSE 8080
+
+# What to run when the container starts
+ENTRYPOINT [ "/app/start.sh" ]
+

README.md

@@ -30,7 +30,7 @@ This project aims to be a full-featured web-based [Apache Kafka](https://kafka.a
 #### Configuration
 ![Configuration Screenshot](images/configuration.png)
 
-## Installation ##
+## Installation from release distribution 
 
 Download the latest [release](https://github.com/SourceLabOrg/kafka-webview/releases) package and extract the ZIP file.
 
@@ -60,9 +60,23 @@ app:
 ### Starting the service
 
 The Kafka WebView UI can be started by running the **start.sh** script from root of the extracted package.
-This should start a webserver running on the port you configured.  
+This should start a webserver running on the port you configured.  Point your browser at `http://your.host.name:8080` or the port that you configured and follow the [Logging in for the first time](#logging-in-for-the-first-time) instructions below.
 
-### Logging in for the first time
+## Running from docker image
+
+Docker images can be found on [Docker Hub](https://hub.docker.com/r/sourcelaborg/kafka-webview).
+
+Start up the latest docker image by running `docker run -it -p 8080:8080 -v kafkawebview_data:/app/data sourcelaborg/kafka-webview:latest`
+
+Point your browser at `http://localhost:8080` and follow the [Logging in for the first time](#logging-in-for-the-first-time) instructions below.
+
+## Building from source
+
+To build and run from the latest source code requires JDK 1.8 and Maven 3.3.9+.  Clone this project and run the [buildAndRun.sh](https://github.com/SourceLabOrg/kafka-webview/blob/master/buildAndRun.sh) script to compile the project and start the service.
+
+Point your browser at `http://localhost:8080` follow the [Logging in for the first time](#logging-in-for-the-first-time) instructions below.
+
+## Logging in for the first time
 
 On first start up a default Administrator user will be created for you.  Login using `admin@example.com` with password `admin`
 

ENVIRONMENT renamed to buildAndRun.sh

@@ -1,10 +1,11 @@
-## This are the required ENV variables for startup for development
+#!/bin/bash
 
+## These are the required ENV variables for startup for development
 ## Define what configs to load on start
 export SPRING_CONFIG_LOCATION=classpath:/config/base.yml,classpath:/config/dev.yml
 
 ## What port to listen on
 export PORT=8080
 
 ## run application via maven
-mvn -pl kafka-webview-ui spring-boot:run
+mvn -pl kafka-webview-ui spring-boot:run -DskipCheckStyle=true -DskipTests=true -DskipLicenseCheck=true

kafka-webview-ui/src/assembly/distribution/start.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/sh
 
 CWD=`pwd`
 

pom.xml

@@ -59,6 +59,7 @@
         <!-- test toggling -->
         <skipTests>false</skipTests>
         <skipCheckStyle>false</skipCheckStyle>
+        <skipLicenseCheck>false</skipLicenseCheck>
     </properties>
 
     <!-- Use Spring Boot Starter as Parent -->
@@ -138,8 +139,9 @@
                 <configuration>
                     <header>LICENSE.txt</header>
                     <includes>
-                        **/**.java
+                        <include>**/**.java</include>
                     </includes>
+                    <skip>${skipLicenseCheck}</skip>
                 </configuration>
                 <executions>
                     <execution>