From 703c23a85ed99f0226a1fd874250c45da50c579d Mon Sep 17 00:00:00 2001
From: Daniel Wasserlauf <daniel.wasserlauf@gmail.com>
Date: Wed, 28 Sep 2022 19:18:06 -0400
Subject: [PATCH] Update for tutorial and docker version updates

---
 Dockerfile.master |  6 ++--
 Dockerfile.server |  4 +--
 README.md         | 89 ++++++++++++++++++++++++++++++++++++++++++++---
 3 files changed, 90 insertions(+), 9 deletions(-)

diff --git a/Dockerfile.master b/Dockerfile.master
index 0f89189..831c1f6 100644
--- a/Dockerfile.master
+++ b/Dockerfile.master
@@ -2,9 +2,9 @@
 FROM eclipse-temurin:17.0.3_7-jre-alpine
 
 # Versioning
-ARG MULTIPAPER_VERSION=1.18.2
-ARG MULTIPAPER_BUILD=95
-ARG MASTER_VERSION=2.8.8
+ARG MULTIPAPER_VERSION=1.19.2
+ARG MULTIPAPER_BUILD=35
+ARG MASTER_VERSION=2.10.1
 
 # Setup groups and install dumb init
 RUN addgroup --gid 1001 multipaper && \
diff --git a/Dockerfile.server b/Dockerfile.server
index cfa7c7f..b5d0b7b 100644
--- a/Dockerfile.server
+++ b/Dockerfile.server
@@ -2,8 +2,8 @@
 FROM eclipse-temurin:17.0.3_7-jre-alpine
 
 # Versioning
-ARG VERSION=1.18.2
-ARG BUILD=95
+ARG VERSION=1.19.2
+ARG BUILD=35
 ARG FULL_VERSION="$VERSION-$BUILD"
 
 # Setup groups and install dumb init
diff --git a/README.md b/README.md
index 8518cdc..c1b7d0e 100644
--- a/README.md
+++ b/README.md
@@ -3,15 +3,96 @@
 MultiPaper Docker images as used in [MultiPaper Helm](https://github.com/MultiPaperK8s/MultiPaperHelm).
 Contains the latest version of MultiPaper server and master backed by hardened Alpine based OpenJDK images.
 
-## Getting Started
-Before getting started, you might want to install the following dependencies:
-
 ### Prerequisits
 - Docker (version 20.10.x and above)
+- [Kind](https://kind.sigs.k8s.io/) for testing the images 
+## Getting Started
+- Clone the project
+- navigate to the project root in your terminal  
+To build the dockerfile images locally run the following commands:  
+
+```sh
+# Builds the server
+docker build -t multipaper-server -f Dockerfile.server .
+
+# Builds the master
+docker build -t multipaper-master -f Dockerfile.master .
+```
+
+Note that in both the dockerfiles you can and _should_ change the version number for the build of multipaper you want to use
+
+```dockerfile
+# In the server dockerfile
+ARG VERSION=1.19.2
+ARG BUILD=35
+
+# In the master dockerfile
+ARG MULTIPAPER_VERSION=1.19.2
+ARG MULTIPAPER_BUILD=35
+ARG MASTER_VERSION=2.10.1
+```
+The versions must line up with the versions released on the Multipaper Downloads page here: https://multipaper.io/download.html
+
+
+
 
 ### Running
+You will need to setup a local kind cluster to test the images locally, alternatively you can use any other kubernetes enviornment to test them. However other kubernetes enviornments for now is an exercise left for the reader. GLHF. 
+
+
+To load the images into a local Kind cluster
+```sh
+kind load docker-image multipaper-master
+kind load docker-image multipaper-server
+```
+
+To run the server clone the helm repository: https://github.com/MultiPaperK8s/MultiPaperHelm
+and update the `image` fields in the `values.yaml` file
+For example
+```yml
+  image:
+    repository: "remcospigot/multipaper-master"
+    # Tag of the Docker image to be used.
+    # Defaults to the Chart's app version if left blank.
+    tag: "2.8.8"
+    pullPolicy: IfNotPresent
+
+# The above would be changed to
+
+  image:
+    repository: "multipaper-master"
+    # Tag of the Docker image to be used.
+    # Defaults to the Chart's app version if left blank.
+    tag: "latest"
+    pullPolicy: IfNotPresent
+
+```
+for the server image section its similar
+
+```yml
+  image:
+    repository: "remcospigot/multipaper"
+    # Tag of the Docker image to be used.
+    # Defaults to the Chart's app version if left blank.
+    tag: "1.18.2-95"
+    pullPolicy: IfNotPresent
+
+# Would be changed to
+
+  image:
+    repository: "multipaper-server"
+    # Tag of the Docker image to be used.
+    # Defaults to the Chart's app version if left blank.
+    tag: "latest"
+    pullPolicy: IfNotPresent
+```
+Note that the repository changes must correspond to the `-t myCoolDockerBuildName` which is the reference kind uses in order to know which image to pull for. 
+
+After changing the `values.yaml` run the helm chart from the root of the https://github.com/MultiPaperK8s/MultiPaperHelm repository.
 
-Coming Soon.
+```sh
+helm install myCoolReleaseNameHere .
+```
 
 ## Images
 Overview of the images currently available for usage.