First working version of deployment environment'

Reviewed-on: #3
This commit is contained in:
Exynox 2024-11-17 11:20:18 +02:00
commit 9a705f42e2
11 changed files with 265 additions and 179 deletions

54
.env.example Normal file
View File

@ -0,0 +1,54 @@
################################################################################
# Docker images
################################################################################
GAME_IMAGE=git.old-metin2.com/metin2/server:latest
WEB_IMAGE=git.old-metin2.com/metin2/web:latest
################################################################################
# MySQL settings
################################################################################
MYSQL_HOST=mysql
MYSQL_USER=root
MYSQL_PASSWORD=metin2
MYSQL_PORT=3306
MYSQL_EXTERNAL_PORT=3306
MYSQL_DB_ACCOUNT=account
MYSQL_DB_PLAYER=player
MYSQL_DB_COMMON=common
MYSQL_DB_LOG=log
################################################################################
# Web app settings
################################################################################
# General configuration
WEB_APP_NAME=Metin2
WEB_APP_ENV=production
WEB_APP_URL=http://metin2.local
WEB_APP_KEY=
WEB_EXTERNAL_PORT=80
# E-mail configuration
WEB_MAIL_MAILER=smtp
WEB_MAIL_HOST=smtp.example.com
WEB_MAIL_PORT=587
WEB_MAIL_USERNAME=smtp-username
WEB_MAIL_PASSWORD=smtp-password
WEB_MAIL_ENCRYPTION=tls
WEB_MAIL_FROM_ADDRESS=no-reply@example.com
WEB_MAIL_FROM_NAME=Metin2
################################################################################
# Game server settings
################################################################################
# Global settings
TEST_SERVER=0
# DBCache settings
DB_ADDR=db
DB_PORT=15000
# Game settings
PUBLIC_IP=127.0.0.1
GAME_MAX_LEVEL=105

3
.gitignore vendored
View File

@ -1,2 +1,5 @@
# Working copy of .env file
.env
# Storage directory
storage/

View File

@ -3,27 +3,62 @@ The Old Metin2 Project aims at improving and maintaining the 2014 Metin2 game fi
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.
## Usage
The deployment strategy for this project is based around Docker Compose. For now, no images are published, so building your own server image is required. Also, for now, you need to provide your own database schema.
## Quick start guide
The deployment strategy for this project is based around Docker Compose.
### Building the server image
This process requires that you do the following steps on a Linux environment with Docker installed and running.
### 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.
Clone the Server project repository:
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).
### Preparing the server
Clone this repository and access its root directory. For instance, on Linux you would do this:
```shell
git clone https://git.old-metin2.com/metin2/server.git
git clone --depth 1 https://git.old-metin2.com/metin2/deploy.git metin2-deploy
cd metin2-deploy/
```
Build the image:
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
cd server
docker build -t metin2/server:test .
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.
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`.
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:<your-key-here>`.
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
Clone this repository and open a terminal window in its root directory. Then, simply bring up the Compose project:
You're ready to start the server. Simply run the following command to start up the server:
```shell
docker compose up -d
docker compose up -d --pull always
```
On the first run, you might need to connect to port 3306 with your favourite MySQL client (Navicat, DBeaver, phpMyAdmin etc.) and install a Metin2 database schema.
On the first run, your database tables will be created and populated with default data.
### Stopping the server
Should you want to stop the server, simply bring down the Docker Compose stack:
```shell
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:
```shell
docker compose up -d mysql web
```

View File

@ -0,0 +1,5 @@
CREATE DATABASE account CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
CREATE DATABASE common CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
CREATE DATABASE log CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
CREATE DATABASE player CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
CREATE DATABASE website CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

View File

@ -1,18 +0,0 @@
CHANNEL: 1
HOSTNAME: auth
PUBLIC_IP: 127.0.0.1
PORT: 11000
P2P_PORT: 12000
DB_ADDR: db
DB_PORT: 15000
PLAYER_SQL: mysql root metin2 account
COMMON_SQL: mysql root metin2 common
LOG_SQL: mysql root metin2 log
TABLE_POSTFIX:
PASSES_PER_SEC: 25
PING_EVENT_SECOND_CYCLE: 180
ADMINPAGE_PASSWORD: metin2adminpass
ADMINPAGE_IP: 127.0.0.1
AUTH_SERVER: master
TRAFFIC_PROFILE:
TEST_SERVER: 0

View File

@ -1,27 +0,0 @@
CHANNEL: 1
HOSTNAME: ch1_first
PUBLIC_IP: 127.0.0.1
PORT: 13000
P2P_PORT: 14000
DB_ADDR: db
DB_PORT: 15000
MAP_ALLOW: 1 4 5 6 3 23 43 112 107 67 68 72 208 302 304
PLAYER_SQL: mysql root metin2 player
COMMON_SQL: mysql root metin2 common
LOG_SQL: mysql root metin2 log
TABLE_POSTFIX:
PASSES_PER_SEC: 25
SAVE_EVENT_SECOND_CYCLE: 180
PING_EVENT_SECOND_CYCLE: 180
VIEW_RANGE: 8000
CHECK_MULTIHACK: 0
ADMINPAGE_PASSWORD: metin2adminpass
ADMINPAGE_IP: 127.0.0.1
SPEEDHACK_LIMIT_COUNT: 300
SPEEDHACK_LIMIT_BONUS: 80
PK_PROTECT_LEVEL: 15
MALL_URL: google.com
TRAFFIC_PROFILE:
TEST_SERVER: 0
MAX_LEVEL: 105
MARK_SERVER: 1

View File

@ -1,26 +0,0 @@
CHANNEL: 1
HOSTNAME: ch1_game1
PUBLIC_IP: 127.0.0.1
PORT: 13001
P2P_PORT: 14001
DB_ADDR: db
DB_PORT: 15000
MAP_ALLOW: 21 24 25 26 108 61 63 69 70 73 216 217 303
PLAYER_SQL: mysql root metin2 player
COMMON_SQL: mysql root metin2 common
LOG_SQL: mysql root metin2 log
TABLE_POSTFIX:
PASSES_PER_SEC: 25
SAVE_EVENT_SECOND_CYCLE: 180
PING_EVENT_SECOND_CYCLE: 180
VIEW_RANGE: 8000
CHECK_MULTIHACK: 0
ADMINPAGE_PASSWORD: metin2adminpass
ADMINPAGE_IP: 127.0.0.1
SPEEDHACK_LIMIT_COUNT: 300
SPEEDHACK_LIMIT_BONUS: 80
PK_PROTECT_LEVEL: 15
MALL_URL: google.com
TRAFFIC_PROFILE:
TEST_SERVER: 0
MAX_LEVEL: 105

View File

@ -1,26 +0,0 @@
CHANNEL: 1
HOSTNAME: ch1_game2
PUBLIC_IP: 127.0.0.1
PORT: 13002
P2P_PORT: 14002
DB_ADDR: db
DB_PORT: 15000
MAP_ALLOW: 41 44 45 46 109 62 64 65 66 71 104 301 351
PLAYER_SQL: mysql root metin2 player
COMMON_SQL: mysql root metin2 common
LOG_SQL: mysql root metin2 log
TABLE_POSTFIX:
PASSES_PER_SEC: 25
SAVE_EVENT_SECOND_CYCLE: 180
PING_EVENT_SECOND_CYCLE: 180
VIEW_RANGE: 8000
CHECK_MULTIHACK: 0
ADMINPAGE_PASSWORD: metin2adminpass
ADMINPAGE_IP: 127.0.0.1
SPEEDHACK_LIMIT_COUNT: 300
SPEEDHACK_LIMIT_BONUS: 80
PK_PROTECT_LEVEL: 15
MALL_URL: google.com
TRAFFIC_PROFILE:
TEST_SERVER: 0
MAX_LEVEL: 105

View File

@ -1,19 +0,0 @@
WELCOME_MSG = "DB Server has been started"
SQL_ACCOUNT = "mysql account root metin2 0"
SQL_PLAYER = "mysql player root metin2 0"
SQL_COMMON = "mysql common root metin2 0"
SQL_HOTBACKUP = "mysql hotbackup root metin2 0"
TABLE_POSTFIX = ""
BIND_PORT = 15000
DB_SLEEP_MSEC = 10
CLIENT_HEART_FPS = 10
HASH_PLAYER_LIFE_SEC = 600
BACKUP_LIMIT_SEC = 3600
PLAYER_ID_START = 100
PLAYER_DELETE_LEVEL_LIMIT = 70
ITEM_ID_RANGE = 10000001 20000000
TEST_SERVER = 0

View File

@ -1,26 +0,0 @@
CHANNEL: 99
HOSTNAME: game99
PUBLIC_IP: 127.0.0.1
PORT: 13099
P2P_PORT: 14099
DB_ADDR: db
DB_PORT: 15000
MAP_ALLOW: 113 81 100 101 103 105 110 111 114 118 119 120 121 122 123 124 125 126 127 128 181 182 183 200
PLAYER_SQL: mysql root metin2 player
COMMON_SQL: mysql root metin2 common
LOG_SQL: mysql root metin2 log
TABLE_POSTFIX:
PASSES_PER_SEC: 25
SAVE_EVENT_SECOND_CYCLE: 180
PING_EVENT_SECOND_CYCLE: 180
VIEW_RANGE: 8000
CHECK_MULTIHACK: 0
ADMINPAGE_PASSWORD: metin2adminpass
ADMINPAGE_IP: 127.0.0.1
SPEEDHACK_LIMIT_COUNT: 300
SPEEDHACK_LIMIT_BONUS: 80
PK_PROTECT_LEVEL: 15
MALL_URL: google.com
TRAFFIC_PROFILE:
TEST_SERVER: 0
MAX_LEVEL: 105

View File

@ -1,34 +1,113 @@
version: '3.3'
x-environment:
&common-environment
MYSQL_HOST: ${MYSQL_HOST}
MYSQL_USER: ${MYSQL_USER}
MYSQL_PASSWORD: ${MYSQL_PASSWORD}
MYSQL_PORT: ${MYSQL_PORT}
MYSQL_DB_ACCOUNT: ${MYSQL_DB_ACCOUNT}
MYSQL_DB_PLAYER: ${MYSQL_DB_PLAYER}
MYSQL_DB_COMMON: ${MYSQL_DB_COMMON}
MYSQL_DB_LOG: ${MYSQL_DB_LOG}
TEST_SERVER: ${TEST_SERVER}
DB_ADDR: ${DB_ADDR}
DB_PORT: ${DB_PORT}
PUBLIC_IP: ${PUBLIC_IP}
GAME_MAX_LEVEL: ${GAME_MAX_LEVEL}
WEB_APP_URL: ${WEB_APP_URL}
WEB_APP_KEY: ${WEB_APP_KEY}
services:
# MySQL Database
mysql:
image: mysql:5.5
restart: always
# The biarms/mysql Docker image supports ARM machines; you may also use mysql:5.5
image: biarms/mysql:5.5
restart: on-failure
environment:
# Password for root access
MYSQL_ROOT_PASSWORD: 'metin2'
MYSQL_ROOT_PASSWORD: ${MYSQL_PASSWORD}
ports:
- '3306:3306'
- '${MYSQL_EXTERNAL_PORT}:${MYSQL_PORT}'
expose:
- 3306
- ${MYSQL_PORT}
volumes:
- ./storage/database/:/var/lib/mysql/
- ./assets/db-init/:/docker-entrypoint-initdb.d/:ro
healthcheck:
test: mysqladmin ping -h localhost -u root -p$$MYSQL_ROOT_PASSWORD
interval: 10s
timeout: 5s
retries: 5
# Web management system
web:
image: ${WEB_IMAGE}
restart: on-failure
environment:
# Application config
APP_NAME: ${WEB_APP_NAME}
APP_ENV: ${WEB_APP_ENV}
APP_KEY: ${WEB_APP_KEY}
APP_URL: ${WEB_APP_URL}
# Database credentials
DB_HOST: ${MYSQL_HOST}
DB_PORT: ${MYSQL_PORT}
DB_USERNAME: ${MYSQL_USER}
DB_PASSWORD: ${MYSQL_PASSWORD}
# E-mail config
MAIL_MAILER: ${WEB_MAIL_MAILER}
MAIL_HOST: ${WEB_MAIL_HOST}
MAIL_PORT: ${WEB_MAIL_PORT}
MAIL_USERNAME: ${WEB_MAIL_USERNAME}
MAIL_PASSWORD: ${WEB_MAIL_PASSWORD}
MAIL_ENCRYPTION: ${WEB_MAIL_ENCRYPTION}
MAIL_FROM_ADDRESS: ${WEB_MAIL_FROM_ADDRESS}
MAIL_FROM_NAME: ${WEB_MAIL_FROM_NAME}
ports:
- '${WEB_EXTERNAL_PORT}:80'
volumes:
- ./storage/web/:/app/storage/
depends_on:
mysql:
condition: service_healthy
healthcheck:
test: curl --fail http://localhost:80/ || exit 1
interval: 10s
timeout: 5s
retries: 5
# DBCache Server
db:
image: metin2/server:test
restart: always
image: ${GAME_IMAGE}
restart: on-failure
environment: *common-environment
expose:
- 15000
- ${DB_PORT}
command: db
volumes:
- ./config/db.txt:/app/conf.txt
- ./storage/log/db/:/app/log/
depends_on:
mysql:
condition: service_healthy
web:
condition: service_healthy
# Auth server
auth:
image: metin2/server:test
restart: always
image: ${GAME_IMAGE}
restart: on-failure
environment:
<<: *common-environment
MYSQL_DB_PLAYER: ${MYSQL_DB_ACCOUNT}
GAME_HOSTNAME: auth
GAME_CHANNEL: 1
GAME_AUTH_SERVER: master
GAME_PORT: 11000
GAME_P2P_PORT: 12000
expose:
- 11000
- 12000
@ -36,13 +115,25 @@ services:
- '11000:11000'
command: game
volumes:
- ./config/auth.txt:/app/CONFIG
- ./storage/log/auth/:/app/log/
depends_on:
mysql:
condition: service_healthy
web:
condition: service_healthy
# Game server (CH1)
ch1_first:
image: metin2/server:test
restart: always
image: ${GAME_IMAGE}
restart: on-failure
environment:
<<: *common-environment
GAME_HOSTNAME: ch1_first
GAME_CHANNEL: 1
GAME_MARK_SERVER: 1
GAME_PORT: 13000
GAME_P2P_PORT: 14000
GAME_MAP_ALLOW: 1 4 5 6 3 23 43 112 107 67 68 72 208 302 304
expose:
- 13000
- 14000
@ -50,13 +141,25 @@ services:
- '13000:13000'
command: game
volumes:
- ./config/ch1/first.txt:/app/CONFIG
- ./storage/log/ch1/first/:/app/log/
- ./storage/mark/:/app/mark/
depends_on:
mysql:
condition: service_healthy
web:
condition: service_healthy
ch1_game1:
image: metin2/server:test
restart: always
image: ${GAME_IMAGE}
restart: on-failure
environment:
<<: *common-environment
GAME_HOSTNAME: ch1_game1
GAME_CHANNEL: 1
GAME_MARK_SERVER: 0
GAME_PORT: 13001
GAME_P2P_PORT: 14001
GAME_MAP_ALLOW: 21 24 25 26 108 61 63 69 70 73 216 217 303
expose:
- 13001
- 14001
@ -64,12 +167,24 @@ services:
- '13001:13001'
command: game
volumes:
- ./config/ch1/game1.txt:/app/CONFIG
- ./storage/log/ch1/game1/:/app/log/
depends_on:
mysql:
condition: service_healthy
web:
condition: service_healthy
ch1_game2:
image: metin2/server:test
restart: always
image: ${GAME_IMAGE}
restart: on-failure
environment:
<<: *common-environment
GAME_HOSTNAME: ch1_game2
GAME_CHANNEL: 1
GAME_MARK_SERVER: 0
GAME_PORT: 13002
GAME_P2P_PORT: 14002
GAME_MAP_ALLOW: 41 44 45 46 109 62 64 65 66 71 104 301 351
expose:
- 13002
- 14002
@ -77,13 +192,25 @@ services:
- '13002:13002'
command: game
volumes:
- ./config/ch1/game2.txt:/app/CONFIG
- ./storage/log/ch1/game2/:/app/log/
depends_on:
mysql:
condition: service_healthy
web:
condition: service_healthy
# Game server (game99)
game99:
image: metin2/server:test
restart: always
image: ${GAME_IMAGE}
restart: on-failure
environment:
<<: *common-environment
GAME_HOSTNAME: game99
GAME_CHANNEL: 99
GAME_MARK_SERVER: 0
GAME_PORT: 13099
GAME_P2P_PORT: 14099
GAME_MAP_ALLOW: 113 81 100 101 103 105 110 111 114 118 119 120 121 122 123 124 125 126 127 128 181 182 183 200
expose:
- 13099
- 14099
@ -91,5 +218,9 @@ services:
- '13099:13099'
command: game
volumes:
- ./config/game99.txt:/app/CONFIG
- ./storage/log/game99/:/app/log/
depends_on:
mysql:
condition: service_healthy
web:
condition: service_healthy