diff options
Diffstat (limited to 'so-monitoring/readme.md')
-rw-r--r-- | so-monitoring/readme.md | 35 |
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 |