# bwLehrpool-Suite - Administration Client for Virtual Machines and Events

The 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 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](../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
A build of the bwLehrpool-Suite requires the installation of the build automation tool [Maven](https://maven.apache.org) and the Java development kit [OpenJDK 8](https://openjdk.java.net/projects/jdk8).

### Dependencies
If a Maven offline build takes place (`mvn -o`), the following dependencies are required and must be built manually first:

  - [ecp-client-lean](https://git.openslx.org/bwlp/ecp-client-lean.git)
  - [master-sync-shared](https://git.openslx.org/bwlp/master-sync-shared.git)
  - [proxy-vole](https://git.openslx.org/bwlp/proxy-vole.git)

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

```shell
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](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-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):

```shell
java -Dlog4j.configurationFile=<CONFIG> -jar <APP>
```


## Execution

### Standalone
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):

```shell
java -jar <APP>
```

Note that the bwLehrpool-Suite application started with the above call uses the production default bwLehrpool-Master-Server of the University of Freiburg.

### Docker infrastructure
If the custom bwLehrpool-Master-Server of the Docker infrastructure from the [masterserver](https://git.openslx.org/bwlp/masterserver.git) repository should be used instead, the bwLehrpool-Suite application can be executed according to the above command line call with the following additional command line parameters:

```shell
java -jar <APP> 192.168.200.10 9090 false
```