aboutsummaryrefslogtreecommitdiff
path: root/docker/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'docker/readme.md')
-rw-r--r--docker/readme.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/docker/readme.md b/docker/readme.md
new file mode 100644
index 00000000..f6b6e550
--- /dev/null
+++ b/docker/readme.md
@@ -0,0 +1,31 @@
+## Configuration
+
+### `/workspace`
+
+Each docker image contains a `/workspace` where all relevant files are located.
+
+
+### `ARG lombokjar=lombok.jar`
+
+When building the image, a lombok.jar will be downloaded to `/workspace`. By default, this is the latest released version. You
+can download a specific version by adding `--build-arg lombokjar=lombok-<major.minor.build>.jar`
+
+### `ARG jdk=9`
+
+The jdk version to be used. Supported values:
+
+- `9` (default)
+- `8`
+
+The version is also accessible in `JDK_VERSION`.
+
+
+### Use fresh lombok.jar
+If you want to use a lombok.jar from your system, assuming `<lombokhome>` contains the path to the lombok directory (where the .git subdirectory is located)
+you can mount your recently built lombok.jar by providing `-v /<lombokhome>/dist/lombok.jar:/workspace/lombok.jar` to the `docker run` command.
+
+
+## Examples
+
+- [gradle](gradle/readme.md)
+- [maven](maven/readme.md)