From cc4c471f16455c0363b0df7b1c3ed78e79ee7fd4 Mon Sep 17 00:00:00 2001
From: ak <akorobov@payneteasy.com>
Date: Tue, 30 Jan 2024 14:58:47 +0300
Subject: [PATCH] Task #78 - README.md file updates

---
 README.md | 26 ++++++++++++++++++++++----
 1 file changed, 22 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 3bd1f73..2f6ba00 100644
--- a/README.md
+++ b/README.md
@@ -20,8 +20,7 @@ logging solution is required. As an example of such
 requirements is PCI DSS requirements 10.1-10.2 
 
 Software requirements:
-1) JDK 17.0.10;
-2) Java Application Container - Tomcat 7.x and higher, Jetty 8.1.x;
+`1) JDK 17.0.10 and higher;
 2) MariaDB 10.0.x and higher;
 3) sphinxsearch 3.6.1 and higher.
 
@@ -30,5 +29,24 @@ Minimum system requirements:
 2) 100GB Disk space (for up to 200 thousands logs per day )
 3) Intell i5, i7, Xeon processors.
 
-
-
+### Building and starting embedded srvlog jetty server
+
+Build uber-jar file:
+
+```shell
+mvn clean package
+```
+Set environment variables required for embedded server:
+```shell
+export JETTY_PORT=8080 # server port
+export JETTY_CONTEXT=/srvlog # web application context path
+export JETTY_ENV_CONFIG_PATH=/path/to/jetty-env-ui.xml # server env config xml
+export WEB_DESCRIPTOR_PATH=/path/to/web.xml # web application config xml
+export WEB_SOCKET_ENDPOINT_PATH=/ws-log # web socket endpoint context path
+export WEB_SOCKET_MAX_MESSAGE_SIZE=65535 # web socket max message size in bytes
+export WEB_SOCKET_IDLE_TIMEOUT_SECONDS=300 # web socket idle timeout in seconds
+```
+Start server uber-jar:
+```shell
+java -jar ./srvlog-web/target/srvlog-embed-server.jar
+```
\ No newline at end of file