This repository is a wrapper around the module repositories of the SPN system: gameserver, relayserver and website. It provides scripts to (hopefully) simplify common tasks like preparing a new setup and running the programs.
Schlangenprogrammiernacht is a programming game written for the GPN19. It is inspired by slither.io, but here only bots written by the players play against each other in a controlled environment.
For both development and production setups you need to have some dependencies installed. You can use the following scripts to install them (or at least find out what you need to install):
| Distribution | Script |
|---|---|
| openSUSE (Tumbleweed) | ./install_deps_opensuse.sh |
| Debian | ./install_deps_debian.sh |
| Arch Linux | ./install_deps_arch.sh |
This section describes the setup of a server system. It starts with setting up a development system and in the end documents the remaining steps to convert that to a “production” system.
A separate system user for running the SPN software is strongly recommended. We will assume here that this user is called spn. You can create it as follows:
$ useradd -m spnAll major components of the system (gameserver, relayserver, website) are located in Git submodules, which must first be initialized. After cloning this repository, run:
$ git submodule update --init --recursiveYou can use ./dev_checkout_newest_version.sh to check out the latest commit
in each submodule instead of the currently referenced one.
If this is your initial setup, you first need to set up mariadb. There's a
pretty handy guide
in the Arch Linux Wiki, this should work for other platforms, too.
After the basic setup, create one user and database for SPN:
CREATE USER 'spn'@'localhost' IDENTIFIED BY 'MyVerySecurePassword!';
CREATE DATABASE spn;
GRANT ALL PRIVILEGES ON spn.* TO 'spn'@'localhost';When you're done setting up one database and one user which has all privileges in that db, you now need to adjust some configuration files:
- Configure database connection in
gameserver/src/Environment.h - Copy
website/Programmierspiel/local_settings.py.exampletowebsite/Programmierspiel/local_settings.pyand configure database connection.
Use the same database config for both files, even if the examples differ.
On most systems, it is sufficient to add a user to the docker group in order to give access. Do so as follows:
$ gpasswd -a spn dockerMake sure you re-login into the spn account before testing. If docker doesn't work afterwards, look at the documentation for docker on your distribution.
Also don't forget to start the docker service.
$ systemctl start dockerFinally, build the base image for the bots:
$ cd gameserver/docker4bots
$ ./0_build_spn_cpp_base.shIt is recommended (and in a production setup mandatory) to use a reverse proxy in front of the website.
The reverse proxy separates the viewer websocket connection from the normal website requests and redirects it to the relayserver. It also serves static files in the production setup (see below).
There is a template configuration in helper_scripts/nginx.conf. Copy it to
your Nginx configuration and adjust it to your needs.
For a quick setup, you can also run Nginx in a Docker container. To do so, use
the script helper_scripts/run_reverseproxy.sh.
If you don't want to set up a reverse proxy, you can alternatively set up a
little hack in website/visualization/Game.js by inserting
return 'ws://localhost:9009/websocket';above
return (window.location.protocol == "https:" ? "wss://" : "ws://") + window.location.host + "/websocket";The shared memory used by the gameserver to communicate with the bots is
realized as memory-mapped files on a tmpfs. It is located at /mnt/spn_shm.
Unfortunately, the location is currently not easy to change, so please use this directory if possible.
First, create the directory:
$ mkdir /mnt/spn_shmFor quick testing, there is a script that sets up the tmpfs:
$ gameserver/docker4bots/00_setup_shm_for_test.shIf you want a more permanent setup, add this line to /etc/fstab:
none /mnt/spn_shm tmpfs size=1G,noexec,uid=spn 0 0
There is a helper script that compiles the major components and sets up a Python virtual environment for the Django-based website:
$ ./build.shTo make the documentation available to the players, do the following:
$ cd website/docs/doxygen
$ mkdir -p ../static/docs/doxygen_cpp
$ doxygenNow you can run the programs. If you want to run them manually, there is a
little helper script starting a tmux session with a window for each program
that’s already in the right working directory:
$ ./dev_manual_tmux.shThere’s also a script that runs all programs directly in a tmux session:
$ ./run.shIf you use the template nginx.conf as-is, you should now be able to access
the SPN server on http://localhost:3000 .
NEVER open this server to the Internet. Django’s debug mode will allow everybody to gain full access to the user account Django is running on. To get a secure setup, read the next section.
This section modifies the setup described above such that it can be provided to a wider audience.
Django’s debug mode must be disabled and static files should be served by the
reverse proxy. To accomplish this, adjust
website/Programmierspiel/local_settings.py as follows (add variables that
don’t exist yet):
DEBUG = False
ALLOWED_HOSTS = ['127.0.0.1', 'your.domain.here']
SECRET_KEY = 'make_sure_you_do_not_use_the_one_in_the_template!'
STATIC_ROOT = '/var/www/spn/staticfiles'Add the following to your Nginx configuration:
location /static/ {
alias /var/www/spn/staticfiles/;
}
Then, store the static files in the configured directory:
$ cd website
$ source env/bin/activate
$ ./manage.py collectstaticRestart Nginx and all SPN programs.
You now have a safe SPN production server that hopefully succeeds in killing some productivity 😈
This is a collection of SPN-related things developed by others.
- Ansible role for installing SPN on Debian 10 by citronalco