Authentication service for the Ely.by and Minecraft
Go to file
ErickSkrauch 16877d502d
Drop usage of goaop, replace implementation with events
2023-11-20 04:39:13 +01:00
api Drop usage of goaop, replace implementation with events 2023-11-20 04:39:13 +01:00
common Fix slash email test 2023-10-15 06:54:35 +02:00
console Enable better logging for queue 2023-10-15 04:09:09 +02:00
data Replace emarref/jwt with lcobucci/jwt 2019-08-01 12:17:12 +03:00
docker Remove user from crontab [deploy] 2021-03-08 09:53:53 +01:00
patches Upgrade codeception to 4 version 2019-12-20 22:50:47 +03:00
.dockerignore Tune nginx conf 2019-11-27 03:41:27 +03:00
.env.dist Make Chrly's domain configurable 2021-03-04 05:58:07 +01:00
.gitattributes Completely untie the backend from the frontend. 2019-04-06 15:52:23 +02:00
.gitignore Translate all code comments from Russian to English [skip ci] 2019-07-15 01:59:56 +03:00
.gitlab-ci.yml Merge pull request #21 from elyby/iss_20_minecraftservices_profile 2022-12-10 00:16:40 +01:00
.php_cs.dist Upgrade PHP to 7.3 and fix some related code errors. Disable self_accessor fixer for PHP-CS-Fixer 2019-04-06 04:15:23 +02:00
Dockerfile Fixes #30. Upgrade MariaDB base image 2023-11-16 20:43:43 +01:00
LICENSE Translate readme, add license and some composer.json fields 2020-05-20 02:36:32 +03:00
README.md Fix typos in README 2020-05-21 14:41:29 +03:00
autocompletion.php Replace separate minecraft access tokens with JWT 2019-12-04 21:10:15 +03:00
codeception.dist.yml Rework tests structure. Upgrade codeception to 2.5.3. Merge params configuration into app configuration. 2019-02-20 22:58:52 +03:00
composer.json Drop usage of goaop, replace implementation with events 2023-11-20 04:39:13 +01:00
composer.lock Drop usage of goaop, replace implementation with events 2023-11-20 04:39:13 +01:00
docker-compose.dist.yml Update dist docker-compose configuration [skip ci] 2021-03-28 03:00:26 +02:00
yii Update ely/php-code-style and run updated CS fixer 2019-02-26 02:26:02 +03:00

README.md

Accounts Ely.by

Ely.by's accounts management service, which provides a single entry point for our own services, as well as for external projects via the OAuth2 protocol. It also implements authorization server for Minecraft game servers and partially implements Mojang-compatible API for obtaining accounts' information.

Warning: this project is not intended for use outside of the ecosystem of Ely.by's services.

Development

The project is designed to work in a Docker environment. Installation links:

First you need to fork the repository and clone it. After that you need to create local .env and docker-compose.yml files:

cp .env.dist .env
cp docker-compose.dist.yml docker-compose.yml

The copied files can be adjusted for your local environment, but generally they are ready to use without any intervention.

Containers will not install dependencies automatically, so you have to install them manually. If you have php and composer installed on your system, you can install dependencies with the composer install command. You can also install dependencies using the container:

docker-compose run --rm --no-deps app composer install

At the first start, all base images will be loaded and built (it can take a long time for the application's image), after which you will be able to begin the development.

To start all containers, use the following command:

docker-compose up -d

By default, docker-compose.yml specifies 80 port for the web service and 8080 port for phpMyAdmin. If these services emits ports-related errors, it is necessary to make the required ports available or change them, and then run the docker-compose up -d command again.

User interface

This repository contains only the source code for the backend API while the interface is in the separate repository. Linux and Mac users can use the following script to get the latest version of the UI:

curl -s https://api.github.com/repos/elyby/accounts-frontend/releases/latest \
 | grep "browser_download_url.*tar.gz" \
 | cut -d : -f 2,3 \
 | tr -d \" \
 | xargs curl -sLo /tmp/accounts-frontend.tar.gz \
&& rm -rf frontend \
&& mkdir -p frontend \
&& tar -zxf /tmp/accounts-frontend.tar.gz -C frontend \
&& rm -f /tmp/accounts-frontend.tar.gz

If this script didn't work for you, you can manually go to the releases page, download the suitable build-archive and extract all its contents into the frontend folder.

How to enter into a working container

Using the docker-compose exec command you can easily execute any desired command in a running container by using its service's name from the docker-compose.yml file. For example, to enter the shell of the app container, use the following command:

docker-compose exec app bash

License

This library is released under the Apache 2.0.