From 0d30132de774fc6d22f325524e9aed2a0378ef16 Mon Sep 17 00:00:00 2001 From: Geert Bevin Date: Mon, 13 Feb 2023 17:44:44 -0500 Subject: [PATCH] Readme updates --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 47258fb..4792915 100644 --- a/README.md +++ b/README.md @@ -44,8 +44,21 @@ The resulting archive will be in: If you use any of the byte-code instrumented features , like continuations, metadata merging or lazy-loaded database entities, you'll need to launch your -servlet container with the `-javaagent:[path-to]/rife2-*-agent.jar` argument. -Exactly how is dependent on each servlet container. +servlet container with the `-javaagent:[path-to]/rife2-[version]-agent.jar` +argument. Exactly how is dependent on each servlet container. + +For example, for Apache Tomcat this is typically done by customizing the +`CATALINA_OPTS` environment variable, for instance: + +```shell +CATALINA_OPTS="-javaagent:[path-to]/rife2-[version]-agent.jar" ./bin/catalina.sh run +``` + +For Jetty, it could just be an argument of the `java` call: + +```shell +java -javaagent:[path-to]/rife2-[version]-agent.jar -jar $JETTY_HOME/start.jar +``` ## Making an UberJar @@ -66,7 +79,7 @@ If you use any of the byte-code instrumented features, you'll need to also tell For example: ```bash -java -javaagent:[path-to]/rife2-*-agent.jar -jar app/build/libs/hello-uber-1.0.jar +java -javaagent:[path-to]/rife2-[version]-agent.jar -jar app/build/libs/hello-uber-1.0.jar ``` ## Get in touch