hassantanveer / pantheon

Primary Pantheon project repository

Mahjong Pantheon: automated statistics & assistance for japanese riichi mahjong sessions.

Pantheon project consists of some submodules, each of those might be installed standalone (see instructions in folder of each submodule). To quickly run Pantheon locally using Docker, read further.

You may use github issues for error reports and feature requests. Pull requests are especially welcome :)

• Support chat (EN): https://discord.gg/U5qBkexfEQ
• Support chat (RU): https://t.me/pantheon_support

Production build

To deploy pantheon on your own VPS or personal environment on production mode:

1. Make sure you have Docker, Docker-compose, GNU Make and PHP8+ installed on your system.
2. Create new environment config file in Common/envs/ folder. There are examples inside. If you just want to build pantheon in production mode locally, use prebuiltlocal.env file.
3. Fill new environment file with proper values, mostly it's about hosts, where you want the services to be accessible from the outer internet. Please note: setting up Nginx or any other reverse proxy is your responsibility. You may refer to nginx-reverse-proxy.example.conf file for basic nginx setup and use prebuilt.reverse-proxy.env environment config as a reference.
4. Set up your reverse proxy, add SSL certificates (optionally). Point your reverse proxy entry points to following ports:
   1. Game API (Mimir) to port 4001
   2. User API (Frey) to port 4004
   3. Ratings service (Rheda) to port 4002
   4. Mobile assistant (Tyr) to port 4103
   5. Admin panel (Forseti) to port 4107
5. Run the following command: ENV_FILENAME=yourenv.env make prod_compile. This will build and run all containers, and also bootstrap an administrator account ([email protected] with password 123456).
6. Review config files of Frey, Rheda and Mimir - probably you might want to create your local configs for better manageability. You can make config/local/ folders in each subsystem and add there local configs.
7. Basically, you're done :)

Please note that there is no default mail server included, so you probably would want to use external mail api. Please take a look on Frey/src/helpers/mailer_remote_api.php file - this file should be hosted as plain php file on some host, where local mail transfer agent is available. On Frey config, you should set mode to remote_api and set remote url of the mailer_remote_api file and api key according to MAIL_ACTION_KEY value in it.

You might want to use some external mailing service - feel free to modify the mailer_remote_api file in this case.

Development environment

Pantheon developer environment works on *nix hosts (mac, linux, *bsd). Windows-based systems are not supported (while it still MAY work, it is not tested at all, also you may want to try using it under WSL in Windows 10+).

Make sure you have Docker and Docker Compose installed and daemon running on your system. Also Pantheon expects PHP8+ to be installed on your host system for some minor needs. For debugging, please make sure all the php extensions are installed as well, see Dockerfile for a complete list.

Note: on some linux distros almost every docker-related command should be run as root. If nothing happens, or error is displayed, try adding sudo before make.

1. Run make dev to build and start all containers, install dependencies for all projects, run database migrations and start webpack dev servers for Tyr and Forseti.
2. After everything is build, you can use make logs and make php_logs in each subsystem folder to view logs in real-time. Also you may use make shell to get to container shell, if you want to. Notice that killing php-fpm, postgres or nginx will ruin the container entirely. Use Dockerfile to alter their configuration.
3. You can use make stop to stop all containers (without deleting the data) and make kill to stop the container AND clean images (e.g. this will remove all db data).

To create an event and fill it with some data, run make seed, make seed_bigevent or make seed_tournament (with sudo if required). Note that users are re-seeded on each command run.

A separate guide about debugging in PhpStorm IDE is available.

Default ports for services are:

• 4001 for Mimir game management API (http://localhost:4001/)
• 4002 for Rheda interface (http://localhost:4002/)
• 4003 for Tyr mobile interface (http://localhost:4003/)
• 4004 for Frey user management backend (http://localhost:4004/)
• 4007 for Forseti management interface (http://localhost:4007/)
• 5532 for PostgreSQL connections - if you want to use external pgAdmin3/4 or any other client to access your databases.
• 5632 for pgAdmin4 container (http://localhost:5632/), which is run for convenience. You will need to setup initial connections using following credentials:
  • PgAdmin login: [email protected]
  • Password: password
  • Mimir database host: db
  • Mimir database port: 5532
  • Mimir database user: mimir
  • Mimir database password: pgpass
  • Frey database host: db
  • Frey database port: 5532
  • Frey database user: frey
  • Frey database password: pgpass

Mimir and Frey use twirp interface to communicate with other services. See protocol description files in Common folder.

Pull requests

Any pull request should pass all current code style checks; also all unit tests should pass. Don't forget to run make check (with sudo if required) before sending your pull request. To fix all code style issues automatically (in php code only), run make autofix (also sudo may be required).

External services

One may want to use Pantheon API in some own external service. Please make sure you have protoc v3.21.9-r0 so generated binary code matches our protocol version.