bStats

The parent repository of the bStats project.

Repository structure

This repository contains all bStats repositories as submodules. These are

• bstats-backend - The backend of bStats.
• bstats-web - The (new) frontend of bStats (currently disabled).
• bstats-legacy - The original backend and frontend of bStats.
• bstats-metrics - The Java-based metrics classes of bStats.

Currently bStats is in a transition phase from the original backend + frontend to a complete rewrite. The "live" version of bStats is currently running with the old frontend and a combination of old and new backend. Which routes are served by which backend can be found in the Caddy configuration at /prod/volumes/caddy/Caddyfile.

This repository also provides the development environment for bStats.

Run bStats locally

0. Prerequisites

• Docker
• Linux. WSL2 is recommended for Windows. MacOS should work but is untested
• GNU Make (should be available on most Unix systems)

1. Clone repository

When cloning the repository, it is recommended to use the --recursive flag to clone the repository with all submodules.

git clone --recursive git@github.com:Bastian/bStats.git

Alternatively, you can also clone the submodules after cloning this parent repository by running

git submodule init && git submodule update

2. Update submodules

Switch to the master branch of all submodules using the following command:

git submodule foreach 'git checkout master'

3. Start the development environment

Then you can start all services by running the default target of the Makefile:

make

After everything is up and running, bStats should be available at https://bstats.localhost/ with a self-signed certificate.

The services will run in Docker containers, thus no additional dependencies like Node.js and npm are required (even though it is recommended to have them installed for your IDE tooling).

The containers run in dev-mode, which means that the code is mounted into the containers and features like hot-reloading are working. You can just start editing the code without having to do any additional steps.

Start Production

The prod directory contains the production environment for bStats. You have to update the prod/volumes/bstats-legacy/config.json file with your Recaptcha secrets and replace the sessionSecret with a random (long) string of your choosing.

You can then start the services by running make start-prod.

Backups

Redis and Postgres data is backed up to a remote server via SCP. Cronjobs can be set up with the add-backup-cronjobs.sh script in the prod directory.

Disaster Recovery

Assuming the worst happens and the current bStats server explodes. To get back up running, start the prod environment on a new server once and stop it after it has successfully started. Then place the backup Redis dumps (dump.rdb) in the prod/volumes/redis/node-<x>m directory. Make sure that the dump file is the correct one for the current node. You can look at the prod/volumes/redis/node-<x>m/nodes.conf file to find out for which key-range the node is responsible. You can then start the prod again and everything should work again (if it is a new server with a new IP, you ofc also have to update the DNS settings in Cloudflare).

License

This project is licensed under the MIT License.