summaryrefslogtreecommitdiffstats
path: root/so-monitoring/readme.md
diff options
context:
space:
mode:
authork.kazak <k.kazak@samsung.com>2019-07-19 14:59:18 +0200
committerk.kazak <k.kazak@samsung.com>2019-07-19 14:59:18 +0200
commit3cc4c5bf37b4ae20a9809c329ad8aa1889aadbdd (patch)
tree13002e447edd4e302e1fe7ed10955b2f66eb9874 /so-monitoring/readme.md
parentf765cc2ab30384f05af70c4011102389c9462e70 (diff)
basic auth for so-monitoring
Add basic auth for so-monitoring app Issue submitted in pentest report Change-Id: I8e826da9b9f66e893826fd9b40b3b26623b2ab8d Issue-ID: OJSI-169 Signed-off-by: k.kazak <k.kazak@samsung.com>
Diffstat (limited to 'so-monitoring/readme.md')
-rw-r--r--so-monitoring/readme.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/so-monitoring/readme.md b/so-monitoring/readme.md
new file mode 100644
index 0000000000..d4b876c763
--- /dev/null
+++ b/so-monitoring/readme.md
@@ -0,0 +1,35 @@
+# SO Monitoring
+
+----
+
+## Introduction
+
+SO Monitoring provides multiple useful features:
+* Search/Filtering Menu
+* A graphical user interface
+* Workflow pathing
+* Subflow navigation
+* Access to the workflow variables
+
+## Compiling / Running
+
+Compiling is simple: `mvn clean install`
+Compilation may fail if your code is not formatted properly.
+
+## Components
+
+### so-monitoring-handler
+
+
+### so-monitoring-service
+
+Backend API for so-monitoring. Requires basic auth to access it.
+
+Default credentials:
+- with role GUI-Client: gui/password1$
+
+Note that these default users should be changed for production.
+
+### so-monitoring-ui
+
+UI for so-monitoring has a separate README.md - so-monitoring/so-monitoring-ui/src/main/frontend/README.md