summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9f3bce2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# onap-java
+
+This project aims to produce a reference ONAP baseline including JAVA 11.
+It is based on the image 11.0.5-jre-slim maintained by the upstream community
+openjdk.
+
+It includes a user and a group onap.
+
+When you create your own docker from this baseline docker (build thanks to the
+Dockerfile hosted in this repository), you need to copy your jar file under
+/opt/onap/app.jar.
+
+You may specify 2 env variable to customize the way you are starting java:
+
+- ENV JAVA_OPTS: set to -Xms256m -Xmx1g by default
+- ENV JAVA_SEC_OPTS: empty by default