update docs

Author: Crim

README.md

@@ -30,7 +30,41 @@ This project aims to be a full-featured web-based [Apache Kafka](https://kafka.a
 
 ## Installation ##
 
-TODO
+Download the latest [release](https://github.com/SourceLabOrg/kafka-webview/releases) package and extract the ZIP file.
+
+### Configuration
+
+Edit the **config.yml** file at the root of the extracted package. 
+
+The **server port** can be modified to set what port Kafka WebView UI will bind to.  
+
+The **app key** should be modified to be unique to your installation.  This key will be used for symmetric encryption of 
+JKS/TrustStore secrets if you configure any SSL enabled Kafka clusters.
+
+By default config.yml will look similar to:
+
+```yml
+server:
+  port: 8080
+
+security:
+  require-ssl: false
+
+## Various App Configs
+app:
+  key: "SuperSecretKey"
+```
+
+### 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.  
+
+### Logging in for the first time
+
+On first start up a default Administrator user will be created for you.  Login using `[email protected]` with password `admin`
+
+**NOTE** After logging in you should create your own Administrator user and remove the default account.
 
 ## Setup ##
 

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

@@ -9,7 +9,7 @@ cd "${0%/*}"
 export SPRING_CONFIG_LOCATION=classpath:/config/base.yml,config.yml
 
 ## launch webapp
-java -jar kafka-webview*.jar
+java -jar kafka-webview-ui-*.jar
 
 ## Change back to previous directory
 cd $CWD

kafka-webview-ui/src/main/resources/templates/home/helpContent.html

@@ -148,14 +148,14 @@ <h2>Writing Custom Deserializers</h2>
             <br/>
             <h2>Example Project</h2>
             <p class="mb-1">
-                To get up and going quickly, the <a href="#" target="_blank">Kafka-WebView-Example</a> project on GitHub can be cloned and used as a template.
+                To get up and going quickly, the <a href="https://github.com/SourceLabOrg/kafka-webview-examples" target="_blank">Kafka-WebView-Examples</a> project on GitHub can be cloned and used as a template.
                 This Maven based example project is configured with all of the correct dependencies and has a few example implementations.<br/>
             </p>
             <br/>
 
             <h2>Packaging a Jar</h2>
             <p class="mb-1">
-                If you're using the <a href="#" target="_blank">Kafka-WebView-Example</a> project, it should be as simple as issuing the command `mvn package` and retrieving the compiled Jar from the target/ directory.<br/>
+                If you're using the <a href="https://github.com/SourceLabOrg/kafka-webview-examples" target="_blank">Kafka-WebView-Examples</a> project, it should be as simple as issuing the command `mvn package` and retrieving the compiled Jar from the target/ directory.<br/>
                 <br/>
                 If you're building from your own project, you'll need to package a Jar that contains your implementation along with
                 any of it's required dependencies.<br/>
@@ -167,7 +167,7 @@ <h2>Packaging a Jar</h2>
         <div class="tab-pane" id="filters" role="tabpanel">
             <h2>Writing Custom Filters</h2>
             <p class="mb-1">
-                The <a href="https://github.com/Crim/kafka-webview/blob/master/kafka-webview-plugin/src/main/java/org/sourcelab/kafkaview/plugin/filter/RecordFilter.java" target="_blank">RecordFilter Interface</a>
+                The <a href="https://github.com/SourceLabOrg/kafka-webview/blob/master/kafka-webview-plugin/src/main/java/org/sourcelab/kafka/webview/ui/plugin/filter/RecordFilter.java" target="_blank">RecordFilter Interface</a>
                 is provided by Kafka WebView and is NOT part of the standard Kafka library.  The interface looks as follows:<br/>
                 <br>
             </p>
@@ -222,14 +222,14 @@ <h2>Writing Custom Filters</h2>
             <br/>
             <h2>Example Project</h2>
             <p class="mb-1">
-                To get up and going quickly, the <a href="#" target="_blank">Kafka-WebView-Example</a> project on GitHub can be cloned and used as a template.
+                To get up and going quickly, the <a href="https://github.com/SourceLabOrg/kafka-webview-examples" target="_blank">Kafka-WebView-Examples</a> project on GitHub can be cloned and used as a template.
                 This Maven based example project is configured with all of the correct dependencies and has a few example implementations.<br/>
             </p>
             <br/>
 
             <h2>Packaging a Jar</h2>
             <p class="mb-1">
-                If you're using the <a href="#" target="_blank">Kafka-WebView-Example</a> project, it should be as simple as issuing the command `mvn package` and retrieving the compiled Jar from the target/ directory.<br/>
+                If you're using the <a href="https://github.com/SourceLabOrg/kafka-webview-examples" target="_blank">Kafka-WebView-Examples</a> project, it should be as simple as issuing the command `mvn package` and retrieving the compiled Jar from the target/ directory.<br/>
                 <br/>
                 If you're building from your own project, you'll need to package a Jar that contains your implementation along with
                 any of it's required dependencies.<br/>