path: root/dozentenmodul/README.md

bwLehrpool-Suite - Administration Client for Virtual Machines and Events
The bwLehrpool-Suite is a bwLehrpool client application to create and administrate virtual machines for study and coursework.
With the help of the bwLehrpool-Suite, it is possible to download ready-to-use virtual machine templates, which you can adapt locally for your purposes.
Then, the bwLehrpool-Suite is capable to upload these personalized virtual machines to the bwLehrpool-Server, 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
A build of the bwLehrpool-Suite requires the installation of the build automation tool Maven and the Java development kit OpenJDK 8.
Dependencies
If a Maven offline build takes place (mvn -o), the following dependencies are required and must be built manually first:

ecp-client-lean
master-sync-shared
proxy-vole

Application
The bwLehrpool-Suite application can be built automatically by calling Maven with the following command line call:
mvn clean package


A build of the bwLehrpool-Suite application creates a Java archive file (*.jar) that can be found at target/dozmod-client-*-jar-with-dependencies.jar.
Configuration
Logging
The logging of the bwLehrpool-Suite application to the console is implemented with 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-Suite application during a build.
Overwrite Logging Defaults
If logging configurations other than the defaults are required, the configuration file packaged into the bwLehrpool-Suite application can be overwritten by specifying a custom configuration file.
The custom configuration file is specified by executing the bwLehrpool-Suite application with the following command line call where <CONFIG> is an absolute path to the custom configuration file and <APP> is a path to the built bwLehrpool-Suite application (Java archive file):
java -Dlog4j.configuration=file:<CONFIG> -jar <APP>


Execution
The bwLehrpool-Suite application can be executed with the following command line call where <APP> is a path to the built bwLehrpool-Suite application (Java archive file):
java -jar <APP>