aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md31
1 files changed, 25 insertions, 6 deletions
diff --git a/readme.md b/readme.md
index 6eca69d..1e6a603 100644
--- a/readme.md
+++ b/readme.md
@@ -1,5 +1,8 @@
# MOA ZS - README
+This file gives instructions on how to build, test, and deploy MOA ZS.
+See [the technical specification](docs/spec.md) for a more detailed description of MOA ZS and how it can be configured.
+
## Build Instructions
Compilation and Runtime Requirements:
@@ -14,7 +17,8 @@ mvn test
### Run Integration Tests
-Integration tests start with the prefix `IT`. Run them with the following command:
+Integration tests start with the prefix `IT`.
+Run them with the following command:
```
mvn test -P integration-tests
```
@@ -26,12 +30,14 @@ Command:
mvn test -P all-tests
```
-Note that some integration tests (prefix `ITSSL`) rely on a TLS connection and Client Authentication. The following guide explains how to set up TLS and Client Authentication with Apache 2.
+Note that some integration tests (prefix `ITSSL`) rely on a TLS connection and Client Authentication.
+The following guide explains how to set up TLS and Client Authentication with Apache 2.
#### Quick Guide: Set Up SSL (inc. Client Authentication) in Apache 2.
This guide is only needed for running all tests.
-Some tests require SSL protection of the service endpoint with SSL Client Authentication. Here's a quick guide how to set up an Apache 2 service on localhost as a SSL terminating reverse proxy to the zusemsg endpoint that runs on <http://localhost:8081/>.
+Some tests require SSL protection of the service endpoint with SSL Client Authentication.
+Here's a quick guide how to set up an Apache 2 service on localhost as a SSL terminating reverse proxy to the zusemsg endpoint that runs on <http://localhost:8081/>.
1. Install Apache 2.
1. Ensure that mod-proxy is installed and enabled.
@@ -78,7 +84,10 @@ After packaging the application to a `war` file, the application can be deployed
### Configuration
-The folder `src/test/resources/config` serves as a template for configuring the application. This folder can be used as-is for deploying the application in a test or development environment. You may apply changes to this folder to fit the needs of a productive environment. See [specification.md](docs/spec.md) and [application.yaml](src/test/resources/config/application.yaml) for more details.
+The folder `src/test/resources/config` serves as a template for configuring MOA ZS.
+This folder can be used as-is for deploying MOA ZS in a test or development environment.
+You may apply changes to this folder to fit the needs of a productive environment.
+See [specification.md](docs/spec.md) and [application.yaml](src/test/resources/config/application.yaml) for more details.
### Deploy as Standalone Application
@@ -100,7 +109,8 @@ The folder `src/test/resources/config` serves as a template for configuring the
cp src/test/resources/config standalone/ -r
```
- If you rename this folder, the application might not find the configuration file `application.yaml`. Consult [Spring Doc: External Configuration](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html#boot-features-external-config-application-property-files) for further details and alternative ways to configure the application.
+ If you rename this folder, the application might not find the configuration file `application.yaml`.
+ Consult [Spring Doc: External Configuration](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html#boot-features-external-config-application-property-files) for further details and alternative ways to configure the application.
1. Start application.
@@ -108,6 +118,9 @@ The folder `src/test/resources/config` serves as a template for configuring the
(cd standalone && java -jar moa-zs.war)
```
+1. The app2mzs service is reachable under <http://localhost:$SERVER_PORT/services/mzs>.
+ The zuse2app service is reachable under <http://localhost:$SERVER_PORT/services/msg>.
+
### Deploy to Tomcat Container
1. Copy the application package `moa-zs.war` to Tomcat's `webapps` directory.
@@ -122,10 +135,16 @@ The folder `src/test/resources/config` serves as a template for configuring the
cp test/main/resources/config/ $MZS_CONFIG
```
-1. Ensure that the spring-boot application finds `$MZS_CONFIG/application.yaml`. Option a) Add the folder `$MZS_CONFIG` to the class path of the web application, e.g. by specifying the `common.loader` property (see [Tomcat's Class Loader How-To](https://tomcat.apache.org/tomcat-9.0-doc/class-loader-howto.html)). Option b) Set the system property `spring.config.location` to `$MZS_CONFIG/application.yaml`. In that case, make sure that all paths in `$MZS_CONFIG/application.yaml` are absolute paths.
+1. Ensure that the spring-boot application finds `$MZS_CONFIG/application.yaml`.
+ Option a) Add the folder `$MZS_CONFIG` to the class path of the web application, e.g. by specifying the `common.loader` property (see [Tomcat's Class Loader How-To](https://tomcat.apache.org/tomcat-9.0-doc/class-loader-howto.html)).
+ Option b) Set the system property `spring.config.location` to `$MZS_CONFIG/application.yaml`.
+ In that case, make sure that all paths in `$MZS_CONFIG/application.yaml` are absolute paths.
1. Start tomcat.
+1. The app2mzs service is reachable under <http://localhost:$TOMCAT_PORT/moa-zs/services/mzs>.
+ The zuse2app service is reachable under <http://localhost:$TOMCAT_PORT/moa-zs/services/msg>.
+
# Footnotes
[1] https://bugs.openjdk.java.net/browse/JDK-8214098