The BZFlag project hosts centralized services for listing public servers and authenticating registered players. This project is the third iteration of the central services and aims to provide a legacy interface compatible with the v2 services and also provide a modern REST API with additional functionality. Another goal is support for CGNAT and, on the REST API, IPv6, both of which are pain points with the current v2 authentication system.

• Apache
• PHP 8.2 FPM
• Composer
• MariaDB
• Redis
• An existing phpBB installation

Install dependencies:

composer install --no-dev

Ensure that PHP can write to var/log/:

sudo chown www-data:www-data var/log/

Create a config.php file at the top level of the source with at least the following, adjusting values as needed:

<?php

return [
  'legacy_host' => 'my.bzflag.whatever',
  'phpbb' => [
    'root_path' => '/var/www/forum/',
    'database' => 'forum',
  ],
  'database' => [
    'database' => 'central',
    'username' => 'central',
    'password' => 'PutPasswordHere'
  ]
];

See public/index.php for additional configuration options.

This assumes the phpbb database is 'forum' with a prefix of 'phpbb_', the central services database is 'central', and the central services user is 'central'. Adjust the below to match your environment.

GRANT SELECT, INSERT, UPDATE, DELETE ON central.* TO central@localhost;
GRANT SELECT ON forum.phpbb_groups TO central@localhost;
GRANT SELECT ON forum.phpbb_user_group TO central@localhost;
GRANT SELECT, UPDATE ON forum.phpbb_users TO central@localhost;

Import structure.sql into the 'central' database.

The REST API uses PHP 8 Attributes to describe the API and zircote/swagger-php to generate an OpenAPI specification. Swagger UI can then be used to display the API specification in a developer friendly way that allows trying it out in a browser. To generate the specification, run the following commands:

composer -d tools install
./tools/vendor/bin/openapi src/Controller/v1 -o ../central.bzflag.org-docs/public/v1.yaml -b vendor/autoload.php

Copyright (C) 2023-2024 BZFlag & Associates

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

Some files are distributed under different licenses:

• public/js/js-cookie.min.js: MIT License, Copyright (c) 2018 Copyright 2018 Klaus Hartl, Fagner Brack, GitHub Contributors
• public/images/weblogin_logo.png (and other formats): GNU LGPL 2.1, Copyright (c) 2024 Tim Riker
• theme toggle SVG/CSS in views/weblogin.html.twig and public/css/weblogin.css: MIT License, Copyright (c) 2021 Alfred Jones
• public/css/bootstrap.min.css and public/css/bootstrap.min.css.map (copied during composer install): MIT License, Copyright (c) 2011-2024 The Bootstrap Authors