diff --git a/README.md b/README.md index 008dd59..994fa95 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,102 @@ # The Metin2 Deployment Files -The Old Metin2 Project aims at improving and maintaining the 2014 Metin2 game files up to modern standards. The goal is to archive the game as it was in order to preserve it for the future and enable nostalgic players to have a good time. +The Old Metin2 Project aims at improving and maintaining the 2014 Metin2 game +files up to modern standards. The goal is to archive the game as it was in +order to preserve it for the future and enable nostalgic players to have a +good time. + +For-profit usage of this material is certainly illegal without the proper +licensing agreements and is hereby discouraged (not legal advice). Even so, the +nature of this project is HIGHLY EXPERIMENTAL - bugs are to be expected for now. + +## Compatibility matrix +| **Operating system** | amd64 | i386 | arm64 | armv7 | Notes | +|------------------------|-------|------|-------|-------|------------------------------------------------------------| +| **Debian 11** | ⚠️ | ❔ | ❔ | ❌ | Requires `EVENT_NOEPOLL=1` environment variable to be set. | +| **Debian 12** | ✅ | ❔ | ❔ | ❌ | | +| **Ubuntu 22.04.5 LTS** | ✅ | N/A | ❔ | ❌ | | +| **Ubuntu 24.04.1 LTS** | ❔ | N/A | ❔ | ❌ | | +| **Docker on WSL** | ✅ | N/A | ❔ | N/A | | +| **Docker on macOS** | ❔ | N/A | ✅ | N/A | | + +### What about Windows, FreeBSD? macOS? +As described below, the deployment system for The Old Metin2 Project is based +on Docker and Docker Compose. Since support for native Windows, FreeBSD or +macOS Docker containers is experimental at best and unavailable at worst, +the auto-magical deployment system in this repository is not compatible with +these OSs. + +Compiling [the server](https://git.old-metin2.com/metin2/server) +binary and running it on these systems should be possible, but you have to come +up with your own deployment strategy, be it shell scripts, a custom watchdog +program, or simply manually starting the binaries. Moreover, this is currently +outside the scope of the project and unsupported for the time being. -For-profit usage of this material is certainly illegal without the proper licensing agreements and is hereby discouraged (not legal advice). Even so, the nature of this project is HIGHLY EXPERIMENTAL - bugs are to be expected for now. ## Quick start guide The deployment strategy for this project is based around Docker Compose. ### Architecture description -The MySQL database is currently pinned on version 5.5. We're using the [biarms/mysql](https://github.com/biarms/mysql) project in order to provide ARM compatibility for such an old version of MySQL. +The MySQL database is currently pinned on version 5.5. We're using the +[biarms/mysql](https://github.com/biarms/mysql) project in order to provide ARM +compatibility for such an old version of MySQL. -The game cores (`db`, `auth`, `game-*`) are ran by using pre-built images containing the server binaries and game files, provided in the [Server repository](https://git.old-metin2.com/metin2/server/packages). +The game cores (`db`, `auth`, `game-*`) are ran by using pre-built images +containing the server binaries and game files, provided in the +[Server repository](https://git.old-metin2.com/metin2/server/packages). -The web application provides the actual website, item mall and autopatcher functionality. Moreover, it is responsible with maintaining the database schema, creating and updating tables when needed. Pre-built images containing the web application are provided in the [Website repository](https://git.old-metin2.com/metin2/web/packages). +The web application provides the actual website, item mall and autopatcher +functionality. Moreover, it is responsible with maintaining the database schema, +creating and updating tables when needed. Pre-built images containing the web +application are provided in the +[Website repository](https://git.old-metin2.com/metin2/web/packages). ### Preparing the server -Clone this repository and access its root directory. For instance, on Linux you would do this: +Clone this repository and access its root directory. For instance, on Linux you +would do this: ```shell git clone --depth 1 https://git.old-metin2.com/metin2/deploy.git metin2-deploy cd metin2-deploy/ ``` -Now, we need to copy the example environment file and name it `.env`. This file contains all settings used by Docker Compose to start up our project. +Now, we need to copy the example environment file and name it `.env`. This file +contains all settings used by Docker Compose to start up our project. ```shell cp .env.example .env ``` -Some settings aren't yet filled out. The actual settings will differ based on your setup. We'll assume that you're using WSL and Docker on your own computer, and you want to run the server locally, just for yourself. Start with opening the newly copied `.env` file. +Some settings aren't yet filled out. The actual settings will differ based on +your setup. We'll assume that you're using WSL and Docker on your own computer, +and you want to run the server locally, just for yourself. Start with opening +the newly copied `.env` file. -Firstly, we need to configure the web application. Find `WEB_APP_URL` and change it to the URL you would use to access the machine you're installing this on (without a trailing slash!). In our case, simply set it to `http://localhost`. +Firstly, we need to configure the web application. Find `WEB_APP_URL` and change + it to the URL you would use to access the machine you're installing this on + (without a trailing slash!). In our case, simply set it to `http://localhost`. -You might already use port 80 on your machine for something else, in which case we need to configure the app to use another port. Simply change `WEB_EXTERNAL_PORT` to another value, for example `8080`. Don't forget to change `WEB_APP_URL` accordingly, in our case to `http://localhost:8080`. +You might already use port 80 on your machine for something else, in which case +we need to configure the app to use another port. Simply change `WEB_EXTERNAL_PORT` +to another value, for example `8080`. Don't forget to change `WEB_APP_URL` +accordingly, in our case to `http://localhost:8080`. -Next, we need to generate a cryptographic key. We'll make use of Laravel's generator feature, as follows: +Next, we need to generate a cryptographic key. We'll make use of Laravel's +generator feature, as follows: ```shell docker run --rm git.old-metin2.com/metin2/web:latest "php artisan key:generate --show" ``` -Run the above command and configure `WEB_APP_KEY` with the output. You should end up with something like: `WEB_APP_KEY=base64:`. +Run the above command and configure `WEB_APP_KEY` with the output. You should +end up with something like: `WEB_APP_KEY=base64:`. -Lastly, let's switch our focus to the game server. Make sure that `PUBLIC_IP` is set to a value at which you can access your machine. As a rule of thumb, this should be the same value you set in your client's `serverinfo.py`. In our case, leaving a value of `127.0.0.1` should work just fine. +Lastly, let's switch our focus to the game server. Make sure that `PUBLIC_IP` is +set to a value at which you can access your machine. As a rule of thumb, this +should be the same value you set in your client's `serverinfo.py`. In our case, +leaving a value of `127.0.0.1` should work just fine. Don't forget to save your `.env` file! ### Starting the server -You're ready to start the server. Simply run the following command to start up the server: +You're ready to start the server. Simply run the following command to start up +the server: ```shell docker compose up -d --pull always ``` @@ -57,8 +110,29 @@ docker compose down ``` ### Start only some services -This deployment environment can also be used for development purposes. If you need a database and website, but want to run the server in some other way (for example, in an IDE), you can just bring up only the services you need: +This deployment environment can also be used for development purposes. If you +need a database and website, but want to run the server in some other way (for +example, in an IDE), you can just bring up only the services you need: ```shell docker compose up -d mysql web ``` + +## Help! + +### `epoll_wait` issues +On some Linux distributions, kernels are shipped without `epoll_wait` support, +which in turn might lead to the following error being shown (and the server +naturally won't start): + +``` +[warn] epoll_wait: Function not implemented +``` + +Luckily, there is a workaround: disabling the `epoll` backend of libevent. In +order to do this, modify your `&common-environment` section in your +`docker-compose.yml` file by adding the following line: + +``` +EVENT_NOEPOLL: 1 +``` \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml index c244911..f6cd5fe 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -24,7 +24,7 @@ services: mysql: # The biarms/mysql Docker image supports ARM machines; you may also use mysql:5.5 image: biarms/mysql:5.5 - restart: on-failure + restart: always environment: # Password for root access MYSQL_ROOT_PASSWORD: ${MYSQL_PASSWORD} @@ -44,7 +44,7 @@ services: # Web management system web: image: ${WEB_IMAGE} - restart: on-failure + restart: always environment: # Application config APP_NAME: ${WEB_APP_NAME} @@ -83,7 +83,7 @@ services: # DBCache Server db: image: ${GAME_IMAGE} - restart: on-failure + restart: always environment: *common-environment expose: - ${DB_PORT} @@ -99,7 +99,7 @@ services: # Auth server auth: image: ${GAME_IMAGE} - restart: on-failure + restart: always environment: <<: *common-environment MYSQL_DB_PLAYER: ${MYSQL_DB_ACCOUNT} @@ -125,7 +125,7 @@ services: # Game server (CH1) ch1_first: image: ${GAME_IMAGE} - restart: on-failure + restart: always environment: <<: *common-environment GAME_HOSTNAME: ch1_first @@ -151,7 +151,7 @@ services: ch1_game1: image: ${GAME_IMAGE} - restart: on-failure + restart: always environment: <<: *common-environment GAME_HOSTNAME: ch1_game1 @@ -176,7 +176,7 @@ services: ch1_game2: image: ${GAME_IMAGE} - restart: on-failure + restart: always environment: <<: *common-environment GAME_HOSTNAME: ch1_game2 @@ -202,7 +202,7 @@ services: # Game server (game99) game99: image: ${GAME_IMAGE} - restart: on-failure + restart: always environment: <<: *common-environment GAME_HOSTNAME: game99