From a4dcf1ebc4d1559b381c210f19e1d9967f8e7aa2 Mon Sep 17 00:00:00 2001 From: Heiko Scherrer Date: Fri, 13 Sep 2024 08:40:46 +0200 Subject: [PATCH] documentation --- README.md | 25 ++++++++++++++++--- .../admin/app/AdminSecurityConfiguration.java | 2 +- 2 files changed, 22 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 963781c..b158099 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,28 @@ This monitoring application is based on [Spring Boot Admin Server](https://github.com/codecentric/spring-boot-admin) and can be used to visualize the state of a distributed microservice application and monitor and control single services. -It is part of the CORE domain because it can also be used outside logistics projects and belongs to the technical infrastructure components -of a typical microservice application built with Spring Boot. +It is part of the OpenWMS.org CORE domain because it can also be used outside logistics projects and belongs to the technical infrastructure +components of a typical microservice application built with Spring Boot. -In OpenWMS projects it's main purpose in production is to control the log level of single components and categories as well as controlling -caches. +The main purpose in production is to control the log level of single components and categories as well as controlling caches. Viewing the +logs is done with a centralized log monitoring system. + +Additional configuration parameter has been added or preset to the configuration parameters of [Spring Boot Admin Server](https://github.com/codecentric/spring-boot-admin): + +| Configuration parameter name | Default value | Description | +|------------------------------| ----- | ----- | +| `owms.admin.start-page` | `/wallboard` | The existing wallboard page shall be the start page after login. Possible values ``, `/application` | +| `owms.eureka.url` | `http://user:sa@localhost:8761` | URI to connect to the discovery server | +| `owms.eureka.zone` | `${owms.eureka.url}/eureka/` | URI to get the zone settings from Eureka discovery server | +| `owms.srv.hostname` | `localhost` | Hostname that is used to register the Admin UI at the discovery server | +| `owms.srv.protocol` | `http` | Port that is used to register the Admin UI at the discovery server | +| `server.port` | `${PORT:8155}` | Port where the Admin UI web server listening at | + +Supported Spring profiles: + +| Profile name | Description | +| ------------ |-----------------------------------------------------------------------------------------------------------------------------| +| `ELK` | All logs and traces are pushed to Logstash (via syslog) expected to listen on a server with hostname `elk` and port `5000` | ![overview][1] diff --git a/src/main/java/org/openwms/core/admin/app/AdminSecurityConfiguration.java b/src/main/java/org/openwms/core/admin/app/AdminSecurityConfiguration.java index f1bfd20..21d2c46 100644 --- a/src/main/java/org/openwms/core/admin/app/AdminSecurityConfiguration.java +++ b/src/main/java/org/openwms/core/admin/app/AdminSecurityConfiguration.java @@ -31,7 +31,7 @@ import java.net.URI; /** - * A AdminSecurityConfiguration. + * A AdminSecurityConfiguration configures Spring Security of this service. * * @author Heiko Scherrer */