feature: add docker support

Author: unsektor

.dockerignore

@@ -0,0 +1,6 @@
+.git
+.github/
+.env*
+compose*yaml
+Dockerfile
+.dockerignore

.env.dist

@@ -0,0 +1,43 @@
+# initialization
+WORLD_DATABASE_DUMP_URL='https://github.com/TrinityCore/TrinityCore/releases/download/TDB335.21101/TDB_full_world_335.21101_2021_10_15.7z'
+AUTH_DATABASE_DUMP_URL='https://raw.githubusercontent.com/TrinityCore/TrinityCore/refs/heads/3.3.5/sql/base/auth_database.sql'
+CHARACTERS_DATABASE_DUMP_URL='https://raw.githubusercontent.com/TrinityCore/TrinityCore/refs/heads/3.3.5/sql/base/characters_database.sql'
+
+EXTRACTED_DATA_ARCHIVE_URL='https://github.com/wowgaming/client-data/releases/download/v16/data.zip'
+MPQ_DATA_INTERFACE_URL='https://raw.githubusercontent.com/wowgaming/3.3.5-interface-files/refs/heads/main/GlobalStrings.lua'
+
+# http
+HTTP_HOST=localhost
+HTTP_PORT=8117
+
+# mysql
+MYSQL_HOST=mysql
+MYSQL_USER=root
+MYSQL_PWD=root
+MYSQL_DATABASE=aowow
+MYSQL_ROOT_PASSWORD=root
+
+# aowow specific environment
+DB_AOWOW_HOST=mysql:3306
+DB_AOWOW_USER=root
+DB_AOWOW_PASS=root
+DB_AOWOW_DB=
+DB_AOWOW_PREFIX=aowow_
+
+DB_WORLD_HOST=mysql:3306
+DB_WORLD_USER=root
+DB_WORLD_PASS=root
+DB_WORLD_DB=trinitycore_world
+DB_WORLD_PREFIX=
+
+DB_AUTH_HOST=mysql:3306
+DB_AUTH_USER=root
+DB_AUTH_PASS=root
+DB_AUTH_DB=trinitycore_auth
+DB_AUTH_PREFIX=
+
+DB_CHARACTERS_1_HOST=mysql:3306
+DB_CHARACTERS_1_USER=root
+DB_CHARACTERS_1_PASS=root
+DB_CHARACTERS_1_DB=trinitycore_characters
+DB_CHARACTERS_1_PREFIX=

.gitignore

@@ -1,3 +1,6 @@
+# Environment
+.env
+
 # Git
 *.orig
 
@@ -50,4 +53,3 @@
 /static/uploads/screenshots/*
 /static/uploads/signatures/*
 /static/uploads/temp/*
-

.htaccess

@@ -2,6 +2,11 @@ Order Deny,Allow
 <FilesMatch "\.(conf|php|in)$">
     Deny from all
 </FilesMatch>
+
+<FilesMatch "\.(yaml|md|env|.dist)$">
+    Deny from all
+</FilesMatch>
+
 <FilesMatch "^(index)\.php$">
     Allow from all
 </FilesMatch>

Dockerfile

@@ -0,0 +1,31 @@
+FROM php:8.2-apache AS php-base
+
+RUN <<EOF
+set -aeux
+apt-get update
+apt-get install -y libfreetype-dev libjpeg62-turbo-dev libpng-dev libonig-dev libxml2-dev default-mysql-client libarchive-tools
+docker-php-ext-configure gd --with-freetype --with-jpeg
+docker-php-ext-install -j$(nproc) gd mbstring xml pdo_mysql mysqli
+EOF
+
+RUN a2enmod rewrite
+
+COPY ./docker/aowow/usr/local/bin/* /usr/local/bin
+
+WORKDIR /var/www/html
+
+CMD ["/usr/local/bin/entrypoint.sh"]
+
+FROM php-base AS php-dev
+
+# fixme: workaround to ignore TLS error on connection to mysql from aowow service: fix it correctly, instead ignoring
+COPY './docker/aowow/(home)/.my.cnf' /root
+
+FROM php-base AS php-prod
+
+COPY . .
+
+FROM mariadb:12.0 AS mysql-dev
+
+RUN apt update && apt-get install p7zip curl -y
+RUN mkdir -p /usr/local/share/mysql ; chown mysql:mysql /usr/local/share/mysql

README.md

@@ -96,6 +96,40 @@ WAV-files need to be reencoded as `ogg/vorbis` and some MP3s may identify themse
 This should guide you through with minimal input required from your end, but will take some time though, especially compiling the zone-images. Use it to familiarize yourself with the other functions this setup has. Yes, I'm dead serious: *Go read the code!* It will help you understand how to configure AoWoW and keep it in sync with your world database.  
 When you've created your admin account you are done.
 
+## Install with Docker
+
+```sh
+cp .env.dist .env  # 
+# ... then edit `.env` according to your environment, or leave as-is for development
+
+# for development
+docker compose up -f compose.yaml -f compose.dev.yaml
+
+# for production 
+docker compose up
+```
+
+> [!NOTE]
+> First launch may take long time (up to 30 minutes and more), application requires initialization
+> (download database dumps, load dumps into database, download game data, extract media/info, etc ...)
+> Please, be patient.
+
+Then web-application should be accessible at <http://localhost:8117>
+
+<details>
+  <summary>Change web-server port:</summary>
+
+Change `HTTP_PORT` environment variable in `.env` or override it on docker launch:
+
+```sh
+HTTP_PORT=8042 docker compose up
+```
+
+</details>
+
+> [!NOTE]
+> First launch may fail for some reason (e.g. fail to download data, slow network & healthcheck fail),
+> it's recommended to rebuild containers for initialization scripts invocation.
 
 ## Troubleshooting
 

compose.dev.yaml

@@ -0,0 +1,46 @@
+services:
+    mysql:
+        build:
+            dockerfile: Dockerfile
+            target: mysql-dev
+            context: .
+        volumes:
+            - ./docker/mysql/docker-entrypoint-initdb.d:/docker-entrypoint-initdb.d:ro
+            - setup_mysql:/usr/local/share/mysql:rw
+            - data_aowow:/var/lib/mysql
+        env_file:
+            - path: .env
+              required: true
+        extra_hosts:
+            # ... workaround to reuse services common environment variables, and make it working for service itself
+            - 'mysql:127.0.0.1'
+        healthcheck:  # fixme on first launch
+            test: [ "CMD", "healthcheck.sh", "--connect", "--innodb_initialized" ]
+            start_period: 1m
+            start_interval: 10s
+            interval: 1m
+            timeout: 5s
+            retries: 5
+
+    aowow:
+        build:
+            dockerfile: Dockerfile
+            target: php-dev
+            context: .
+        volumes:
+            - .:/var/www/html:ro
+            - ./docker/aowow/src/config/config.php:/var/www/html/config/config.php:ro
+            # - ./docker/aowow/(home)/.my.cnf:/root/.my.cnf:ro
+            # - ./docker/aowow/usr/local/bin/entrypoint.sh:/usr/local/bin/entrypoint.sh:ro
+            - ./docker/aowow/usr/local/bin/initialize.sh:/usr/local/bin/initialize.sh:ro
+            - ./docker/aowow/usr/local/bin/initialize.d:/usr/local/bin/initialize.d:ro
+        depends_on:
+            mysql:
+                condition: service_healthy
+
+volumes:
+    setup_mysql:
+        # Contains database dump file. Required for aowow.
+        # After setup is done, all data could be wiped, e.g. `find /usr/local/share/ -type f -delete`
+    data_aowow:
+        # Let database data live outside the container.

compose.yaml

@@ -0,0 +1,21 @@
+services:
+    aowow:
+        build:
+            dockerfile: Dockerfile
+            target: php-prod
+            context: .
+        volumes:
+            # ... assume all infrastructure setup is done,
+            - setup_aowow:/var/www/html/setup/mpqdata:rw  # `w` for assets download case
+        ports:
+            - "${HTTP_PORT:-80}:80"
+        env_file:
+            - path: .env
+              required: true
+
+volumes:
+    setup_aowow:
+        # Contains extracted files from MPQ archives (dbc files). Required for aowow setup on initialization.
+        # After setup is done, all data could be wiped, e.g. `find /usr/local/share/ -type f -delete`
+    data_aowow:
+        # Application data. Reused between application deployments.

docker/aowow/(home)/.my.cnf

@@ -0,0 +1,2 @@
+[client]
+skip-ssl = true

docker/aowow/src/config/config.php

@@ -0,0 +1,32 @@
+<?php
+if (!defined('AOWOW_REVISION'))
+    die('illegal access');
+
+$AoWoWconf['aowow'] = array (
+    'host' => getenv('DB_AOWOW_HOST') ?? 'localhost:3306',
+    'user' => getenv('DB_AOWOW_USER') ?? 'root',
+    'pass' => getenv('DB_AOWOW_PASS') ?? 'root',
+    'db' =>  getenv('DB_AOWOW_DB') ??'aowow',
+    'prefix' => getenv('DB_AOWOW_PREFIX') ?? 'aowow_',
+);
+$AoWoWconf['world'] = array (
+    'host' => getenv('DB_WORLD_HOST') ?? 'localhost:3306',
+    'user' => getenv('DB_WORLD_USER') ?? 'root',
+    'pass' => getenv('DB_WORLD_PASS') ?? 'root',
+    'db' => getenv('DB_WORLD_DB') ?? 'trinitycore_world',
+    'prefix' => getenv('DB_WORLD_PREFIX') ?? '',
+);
+$AoWoWconf['auth'] = array (
+    'host' => getenv('DB_AUTH_HOST') ?? 'localhost:3306',
+    'user' => getenv('DB_AUTH_USER') ?? 'root',
+    'pass' => getenv('DB_AUTH_PASS') ?? 'root',
+    'db' => getenv('DB_AUTH_DB') ?? 'trinitycore_auth',
+    'prefix' => getenv('DB_AUTH_PREFIX') ?? '',
+);
+$AoWoWconf['characters']['1'] = array (
+    'host' => getenv('DB_CHARACTERS_1_HOST') ?? 'localhost:3306',
+    'user' => getenv('DB_CHARACTERS_1_USER') ?? 'root',
+    'pass' => getenv('DB_CHARACTERS_1_PASS') ?? 'root',
+    'db' =>  getenv('DB_CHARACTERS_1_DB') ?? 'trinitycore_characters',
+    'prefix' => getenv('DB_CHARACTERS_1_PREFIX') ?? '',
+);