From 448efdb25558d1b53109a442db94ae6b3844d9a2 Mon Sep 17 00:00:00 2001 From: Manuel Bentele Date: Tue, 25 May 2021 07:59:56 +0200 Subject: [client,server] Add a newline after each sentence in the documentation --- README.md | 3 ++- dozentenmodul/README.md | 11 ++++++++--- dozentenmodulserver/README.md | 21 +++++++++++++++------ 3 files changed, 25 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 23eac65e..06abe69f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # bwSuite & bwLehrpool-Server -The bwSuite (bwLehrpool-Suite) and the bwLehrpool-Server are two applications (client and server) that are part of [bwLehrpool](https://www.bwlehrpool.de). More information about both applications and their configurations can be found in the detailed description of the two application sub-projects: +The bwSuite (bwLehrpool-Suite) and the bwLehrpool-Server are two applications (client and server) that are part of [bwLehrpool](https://www.bwlehrpool.de). +More information about both applications and their configurations can be found in the detailed description of the two application sub-projects: - [bwSuite](dozentenmodul/README.md) - [bwLehrpool-Server](dozentenmodulserver/README.md) diff --git a/dozentenmodul/README.md b/dozentenmodul/README.md index 81b1e9c9..9d78b394 100644 --- a/dozentenmodul/README.md +++ b/dozentenmodul/README.md @@ -1,6 +1,9 @@ # bwSuite - Administration Client for Virtual Machines and Events -The bwSuite (bwLehrpool-Suite) is a [bwLehrpool](https://www.bwlehrpool.de) client application to create and administrate virtual machines for study and coursework. With the help of the bwSuite it is possible to download ready-to-use virtual machine templates, which you can adapt locally for your purposes. Then, the bwSuite is capable to upload these personalized virtual machines to the [bwLehrpool-Server](../dozentenmodulserver/README.md), create new events and link the virtual machines to created events. Additionally, permissions can be set to grant selected or all users access to virtual machines. +The bwSuite (bwLehrpool-Suite) is a [bwLehrpool](https://www.bwlehrpool.de) client application to create and administrate virtual machines for study and coursework. +With the help of the bwSuite it is possible to download ready-to-use virtual machine templates, which you can adapt locally for your purposes. +Then, the bwSuite is capable to upload these personalized virtual machines to the [bwLehrpool-Server](../dozentenmodulserver/README.md), create new events and link the virtual machines to created events. +Additionally, permissions can be set to grant selected or all users access to virtual machines. ## Build @@ -29,10 +32,12 @@ A build of the bwSuite application creates a Java archive file (\*.jar) that can The logging of the bwSuite application to the console is implemented with [log4j](https://logging.apache.org/log4j). #### Default Logging Configurations -The default logging configurations are specified in the property file under `src/main/properties/log4j.properties`. This configuration file is packaged automatically into the bwSuite application during a build. +The default logging configurations are specified in the property file under `src/main/properties/log4j.properties`. +This configuration file is packaged automatically into the bwSuite application during a build. #### Overwrite Logging Defaults -If logging configurations other than the defaults are required, the configuration file packaged into the bwSuite application can be overwritten by specifiying a custom configuration file. The custom configuration file is specified by execute the bwSuite application with the following command line call where `` is an absolute path to the custom configuration file and `` is a path to the built bwSuite application (Java archive file): +If logging configurations other than the defaults are required, the configuration file packaged into the bwSuite application can be overwritten by specifiying a custom configuration file. +The custom configuration file is specified by execute the bwSuite application with the following command line call where `` is an absolute path to the custom configuration file and `` is a path to the built bwSuite application (Java archive file): ```shell java -Dlog4j.configuration=file: -jar diff --git a/dozentenmodulserver/README.md b/dozentenmodulserver/README.md index 1a224197..2e2da57c 100644 --- a/dozentenmodulserver/README.md +++ b/dozentenmodulserver/README.md @@ -1,6 +1,8 @@ # bwLehrpool-Server - Management Server for Virtual Machines and Events -The bwLehrpool-Server is a [bwLehrpool](https://www.bwlehrpool.de) server application to manage virtual machines and events for study and coursework. Already created virtual machines can be uploaded to the bwLehrpool-Server to share those virtual machines with students and workgroup members as well as link them to events. A virtual machine download from the bwLehrpool-Server allows a customization of virtual machines locally for your purposes. +The bwLehrpool-Server is a [bwLehrpool](https://www.bwlehrpool.de) server application to manage virtual machines and events for study and coursework. +Already created virtual machines can be uploaded to the bwLehrpool-Server to share those virtual machines with students and workgroup members as well as link them to events. +A virtual machine download from the bwLehrpool-Server allows a customization of virtual machines locally for your purposes. ## Build @@ -27,7 +29,8 @@ A docker image of the bwLehrpool-Server and its required infrastructure can be b mvn -P dozmod-server:start ``` -Note that a complete Docker infrastructure (images, containers, networks and volumes) is created and started automatically after this call using [docker-compose](https://docs.docker.com/compose). To stop the bwLehrpool-Server container and its entire infrastructure, use the following command line call: +Note that a complete Docker infrastructure (images, containers, networks and volumes) is created and started automatically after this call using [docker-compose](https://docs.docker.com/compose). +To stop the bwLehrpool-Server container and its entire infrastructure, use the following command line call: ```shell mvn -P dozmod-server:stop @@ -37,7 +40,9 @@ mvn -P dozmod-server:stop ## Configuration ### Server -The bwLehrpool-Server application requires a Java property configuration file for its operation. A template for this configuration file can be found at `setup/config.properties.tmpl`. The template can be finalized with the [dockerize](https://github.com/jwilder/dockerize) utility using the following command line call where `DOZMOD_*` are environment variables to finalize the content of the configuration file: +The bwLehrpool-Server application requires a Java property configuration file for its operation. +A template for this configuration file can be found at `setup/config.properties.tmpl`. +The template can be finalized with the [dockerize](https://github.com/jwilder/dockerize) utility using the following command line call where `DOZMOD_*` are environment variables to finalize the content of the configuration file: ```shell export DOZMOD_DATABASE_HOST="192.168.200.20" @@ -55,17 +60,21 @@ dockerize -template setup/config.properties.tmpl:config.properties The logging of the bwLehrpool-Server application to the console is implemented with [log4j](https://logging.apache.org/log4j). #### Default Logging Configurations -The default logging configurations are specified in the property file under `src/main/properties/log4j.properties`. This configuration file is packaged automatically into the bwLehrpool-Server application during a build. +The default logging configurations are specified in the property file under `src/main/properties/log4j.properties`. +This configuration file is packaged automatically into the bwLehrpool-Server application during a build. #### Overwrite Logging Defaults -If logging configurations other than the defaults are required, the configuration file packaged into the bwLehrpool-Server application can be overwritten by specifiying a custom configuration file. The custom configuration file is specified by execute the bwLehrpool-Server application with the following command line call where `` is a an absolute path to the custom configuration file and `` is a path to the built bwLehrpool-Server application (Java archive file): +If logging configurations other than the defaults are required, the configuration file packaged into the bwLehrpool-Server application can be overwritten by specifiying a custom configuration file. +The custom configuration file is specified by execute the bwLehrpool-Server application with the following command line call where `` is a an absolute path to the custom configuration file and `` is a path to the built bwLehrpool-Server application (Java archive file): ```shell java -Dlog4j.configuration=file: -jar ``` ## Execution -An execution of the bwLehrpool-Server application requires an already finalized bwLehrpool-Server configuration file located in the current working directory. This configuration file can be created from a configuration template as explained above. Then, the bwLehrpool-Server application can be executed with the following command line call where `` is a path to the built bwLehrpool-Server application (Java archive file): +An execution of the bwLehrpool-Server application requires an already finalized bwLehrpool-Server configuration file located in the current working directory. +This configuration file can be created from a configuration template as explained above. +Then, the bwLehrpool-Server application can be executed with the following command line call where `` is a path to the built bwLehrpool-Server application (Java archive file): ```shell java -jar -- cgit v1.2.3-55-g7522