README.md

Server

This repository contains the server component of team 17 for the No Time To Spy game of the Softwaregrundprojekt 2019/2020 at the university of Ulm.

Usage

The standard defines several flags for the server startup:

• -h / --help prints some help information and exits.
• -c <path> / --config-charset <path> usage of the given character configuration.
• -m <path> / --config-match <path> usage of the given match configuration.
• -s <path> / --config-scenario <path> usage of the given scenario configuration.
• --x <key> <value> can be used to give the server additional key-value pairs
• -v <int> / --verbosity <int> configuration of the logging verbosity
• -p <int> / --port <int> configuration of the port to be used

Installation

This server can be installed manually and through a docker container.

Manual Installation

Prerequisites

• C++17 compatible Compiler (e.g. GCC-8)
• CMake (at least version 3.10)
• GNU-Make
• spdlog, version 1.6.1 [MIT license]
• CLI11, version 1.9.0 [license]
• afsm [Artistic License 2.0]
• metapushkin (dependency from afsm) [Artistic License 2.0]

For a comfortable installation of the last four prerequisites, the script installDependencies.sh is provided. This assumes that the first three prerequisites are already satisfied.

Compiling the application

Create a directory for the build and change into this. The name of this directory can be arbitrarily chosen, in this example it will be called build.

mkdir build && cd build

Generate a makefile using cmake. This step shouldn't produce any errors if all prerequisites are installed.

cmake ..

Compile the application using make.

make

Test the installation by executing the server.

./server017 -h

Docker

Building the docker container

docker build -t soprateam17/server .

Running the container

docker run --rm -p 7007:7007 soprateam17/server

To get the latest develop branch you can also pull the container from docker hub:

docker pull soprateam17/server

Customizing configuration files with docker

Configuration can be changed by bindmounting a directory with configuration files to /config:

docker run -v ~/customConfig:/config -p 7007:7007 soprateam17/server

With the local configuration files

~/customConfig/characters.json
~/customConfig/matchconfig.match
~/customConfig/scenario.scenario

The local directory path has to begin with / or ~, so if you have a config directory in the current path use

sudo docker run --rm -v "$(pwd)"/myConfig:/config -p 7007:7007 soprateam17/server

systemd service

A service file is provided here. Copy it to /etc/systemd/system/server017.service, execute sudo systemctl daemon-reload and sudo systemctl start server017 to run the server in the background with automatic restart. Whenever the server restarts, it also pulls the latest version from docker hub.

To manually restart (and update) the server, use sudo systemctl restart server017.

Logs can be viewed with sudo journalctl -u server017.