feature: add docker support

Author: unsektor

.dockerignore

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

.env.aowow.dist

@@ -0,0 +1,50 @@
+## mysql specific environment
+MYSQL_HOST=mysql
+## keep as same as `DB_AOWOW_USER`
+MYSQL_USER=root
+## keep as same as `DB_AOWOW_PASS`
+MYSQL_PWD=root
+## keep as same as `DB_AOWOW_DB`
+MYSQL_DATABASE=aowow
+
+## aowow specific environment
+HTTP_HOST=172.28.0.10
+HTTP_PORT=8117
+
+DB_AOWOW_HOST=mysql
+DB_AOWOW_PORT=3306
+DB_AOWOW_USER=root
+DB_AOWOW_PASS=root
+DB_AOWOW_DB=aowow
+DB_AOWOW_PREFIX=aowow_
+
+DB_WORLD_HOST=mysql
+DB_WORLD_PORT=3306
+DB_WORLD_USER=root
+DB_WORLD_PASS=root
+DB_WORLD_DB=trinitycore_world
+DB_WORLD_PREFIX=
+
+DB_AUTH_HOST=mysql
+DB_AUTH_PORT=3306
+DB_AUTH_USER=root
+DB_AUTH_PASS=root
+DB_AUTH_DB=trinitycore_auth
+DB_AUTH_PREFIX=
+
+DB_CHARACTERS_1_HOST=mysql
+DB_CHARACTERS_1_PORT=3306
+DB_CHARACTERS_1_USER=root
+DB_CHARACTERS_1_PASS=root
+DB_CHARACTERS_1_DB=trinitycore_characters
+DB_CHARACTERS_1_PREFIX=
+
+## Setup
+SETUP_SKIP=0
+SETUP_EXTRACTED_DATA_ARCHIVE_URL=https://github.com/wowgaming/client-data/releases/download/v16/data.zip
+SETUP_MPQ_DATA_INTERFACE_URL=https://raw.githubusercontent.com/wowgaming/3.3.5-interface-files/refs/heads/main/GlobalStrings.lua
+
+## Notice: if you are debugging docker container, better to host files locally instead of download everytime files from internet.
+## for example: cd ~/Documents/data-for-aowow-application; python3 -m http.server`
+# SETUP_MPQ_DATA_INTERFACE_URL=http://host.docker.internal:8000/GlobalStrings.lua
+# SETUP_EXTRACTED_DATA_ARCHIVE_URL=http://host.docker.internal:8000/data.zip

.env.mysql.dist

@@ -0,0 +1,22 @@
+## mysql specific environment
+MYSQL_ROOT_PASSWORD=root
+
+## aowow specific environment
+## keep as same as in `.env.aowow`
+DB_AOWOW_USER=root
+DB_AOWOW_PASS=root
+DB_WORLD_DB=trinitycore_world
+DB_AUTH_DB=trinitycore_auth
+DB_CHARACTERS_1_DB=trinitycore_characters
+
+## Setup
+SETUP_SKIP=0
+SETUP_WORLD_DATABASE_DUMP_URL=https://github.com/TrinityCore/TrinityCore/releases/download/TDB335.21101/TDB_full_world_335.21101_2021_10_15.7z
+SETUP_AUTH_DATABASE_DUMP_URL=https://raw.githubusercontent.com/TrinityCore/TrinityCore/refs/heads/3.3.5/sql/base/auth_database.sql
+SETUP_CHARACTERS_DATABASE_DUMP_URL=https://raw.githubusercontent.com/TrinityCore/TrinityCore/refs/heads/3.3.5/sql/base/characters_database.sql
+
+## Notice: if you are debugging docker container, better to host files locally instead of download everytime files from internet.
+## for example: cd ~/Documents/data-for-aowow-application; python3 -m http.server`
+# SETUP_WORLD_DATABASE_DUMP_URL=http://host.docker.internal:8000/mysql/TDB_full_world_335.21101_2021_10_15.7z
+# SETUP_AUTH_DATABASE_DUMP_URL=http://host.docker.internal:8000/mysql/auth_database.sql
+# SETUP_CHARACTERS_DATABASE_DUMP_URL=http://host.docker.internal:8000/mysql/characters_database.sql

.gitignore

@@ -1,3 +1,7 @@
+# Environment
+.env*
+!.env*dist
+
 # Git
 *.orig
 

.htaccess

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

Dockerfile

@@ -0,0 +1,69 @@
+FROM php:8.2-apache AS php-base
+
+RUN <<EOF
+set -aeux
+apt-get update
+apt-get install -y --no-install-recommends --no-install-suggests \
+  libfreetype-dev \
+  libjpeg62-turbo-dev \
+  libpng-dev \
+  libonig-dev \
+  libxml2-dev \
+  libicu-dev \
+  libgmp-dev \
+  default-mysql-client \
+  libarchive-tools
+EOF
+
+RUN <<EOF
+docker-php-ext-configure gd --with-freetype --with-jpeg
+docker-php-ext-install -j$(nproc) gd mbstring xml pdo_mysql mysqli intl gmp
+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 mariadb-dev
+
+RUN apt update && apt-get install p7zip curl -y
+RUN ln -s /usr/bin/mariadb /usr/bin/mysql
+
+HEALTHCHECK --interval=5s --timeout=5s --retries=30 CMD mariadb-admin ping -h 127.0.0.1 -u root -P3306 -p$MYSQL_ROOT_PASSWORD || exit 1
+
+# DEPRECATED: consider to don't use
+FROM mysql:5.7-debian AS mysql-dev
+RUN <<EOF
+set -aeu
+
+cat << 'EOL' > /etc/apt/sources.list
+deb http://archive.debian.org/debian buster main contrib non-free
+deb http://archive.debian.org/debian-security buster/updates main contrib non-free
+deb http://archive.debian.org/debian buster-updates main contrib non-free
+EOL
+
+# cat /etc/apt/sources.list.d/mysql.list
+#curl https://repo.mysql.com/RPM-GPG-KEY-mysql | apt-key add -
+#apt-key adv --recv-keys --keyserver hkp://keyserver.ubuntu.com:80 B7B3B788A8D3785C
+#apt-key adv --keyserver keyserver.ubuntu.com --recv-keys B7B3B788A8D3785C
+#gpg --recv-keys B7B3B788A8D3785C
+#gpg --export B7B3B788A8D3785C | apt-key add -
+
+apt-get update -y --allow-insecure-repositories
+apt-get install p7zip-full curl -y
+EOF
+
+HEALTHCHECK --interval=5s --timeout=5s --retries=30 CMD mysqladmin ping -h 127.0.0.1 -u root -P3306 -p$MYSQL_ROOT_PASSWORD || exit 1

README.md

@@ -1,9 +1,8 @@
 ![logo](static/images/logos/home.png)
 
-
 ## Build Status
-![fuck it ship it](http://forthebadge.com/images/badges/fuck-it-ship-it.svg)
 
+![fuck it ship it](http://forthebadge.com/images/badges/fuck-it-ship-it.svg)
 
 ## Introduction
 
@@ -15,57 +14,81 @@ This is a complete rewrite of the serverside php code and update to the clientsi
 I myself take no credit for the clientside scripting, design and layout that these php-scripts cater to.
 Also, this project is not meant to be used for commercial purposes of any kind!
 
-
 ## Requirements
 
-+ Webserver running PHP ≥ 8.2 including extensions:
-  + [SimpleXML](https://www.php.net/manual/en/book.simplexml.php)
-  + [GD](https://www.php.net/manual/en/book.image)
-  + [MySQL Improved](https://www.php.net/manual/en/book.mysqli.php)
-  + [Multibyte String](https://www.php.net/manual/en/book.mbstring.php)
-  + [File Information](https://www.php.net/manual/en/book.fileinfo.php)
-  + [Internationalization](https://www.php.net/manual/en/book.intl.php)
-  + [GNU Multiple Precision](https://www.php.net/manual/en/book.gmp.php) (When using TrinityCore as auth source)
-+ MySQL ≥ 5.7.0 OR MariaDB ≥ 10.6.4 OR similar
-+ [TDB 335.21101](https://github.com/TrinityCore/TrinityCore/releases/tag/TDB335.21101) (no other other providers are supported at this time)
-+ WIN: php.exe needs to be added to the `PATH` system variable, if it isn't already. 
-+ Tools require cmake: Please refer to the individual repositories for detailed information
-  + [MPQExtractor](https://github.com/Sarjuuk/MPQExtractor) / [FFmpeg](https://ffmpeg.org/download.html) / (optional: [BLPConverter](https://github.com/Sarjuuk/BLPConverter))
-  + WIN users may find it easier to use these alternatives
-     + [MPQEditor](http://www.zezula.net/en/mpq/download.html) / [FFmpeg](http://ffmpeg.zeranoe.com/builds/) / (optional: [BLPConverter](https://github.com/PatrickCyr/BLPConverter))
+- Webserver running PHP ≥ 8.2 including extensions:
+  - [SimpleXML](https://www.php.net/manual/en/book.simplexml.php)
+  - [GD](https://www.php.net/manual/en/book.image)
+  - [MySQL Improved](https://www.php.net/manual/en/book.mysqli.php)
+  - [Multibyte String](https://www.php.net/manual/en/book.mbstring.php)
+  - [File Information](https://www.php.net/manual/en/book.fileinfo.php)
+  - [Internationalization](https://www.php.net/manual/en/book.intl.php)
+  - [GNU Multiple Precision](https://www.php.net/manual/en/book.gmp.php) (When using TrinityCore as auth source)
+- MySQL ≥ 5.7.0 OR MariaDB ≥ 10.6.4 OR similar
+- [TDB 335.21101](https://github.com/TrinityCore/TrinityCore/releases/tag/TDB335.21101) (no other other providers are supported at this time)
+- WIN: php.exe needs to be added to the `PATH` system variable, if it isn't already. 
+- Tools require cmake: Please refer to the individual repositories for detailed information
+  - [MPQExtractor](https://github.com/Sarjuuk/MPQExtractor) / [FFmpeg](https://ffmpeg.org/download.html) / (optional: [BLPConverter](https://github.com/Sarjuuk/BLPConverter))
+  - WIN users may find it easier to use these alternatives
+     - [MPQEditor](http://www.zezula.net/en/mpq/download.html) / [FFmpeg](http://ffmpeg.zeranoe.com/builds/) / (optional: [BLPConverter](https://github.com/PatrickCyr/BLPConverter))
 
 audio processing may require [lame](https://sourceforge.net/projects/lame/files/lame/3.99/) or [vorbis-tools](https://www.xiph.org/downloads/) (which may require libvorbis (which may require libogg))
 
-
 #### Highly Recommended
-+ setting the following configuration values on your TrinityCore server will greatly increase the accuracy of spawn points
+
+- setting the following configuration values on your TrinityCore server will greatly increase the accuracy of spawn points
   > Calculate.Creature.Zone.Area.Data = 1  
   > Calculate.Gameobject.Zone.Area.Data = 1
 
-
 ## Install
+### 1. Acquire the required repositories
 
-#### 1. Acquire the required repositories
-`git clone [email protected]:Sarjuuk/aowow.git aowow`  
-`git clone [email protected]:Sarjuuk/MPQExtractor.git MPQExtractor`  
+```sh
+git clone [email protected]:Sarjuuk/aowow.git aowow
+git clone [email protected]:Sarjuuk/MPQExtractor.git MPQExtractor
+```
+
+### 2. Prepare the database  
 
-#### 2. Prepare the database  
 Ensure that the account you are going to use has **full** access on the database AoWoW is going to occupy and ideally only **read** access on the world database you are going to reference.  
 Import files 01 - 03 from `setup/sql/` in order into the AoWoW database `mysql -p {your-db-here} < setup/sql/01-db_structure.sql`, etc.  
 
-#### 3. Server created files
+### 3. Server created files
+
 See to it, that the web server is able to write the following directories and their children. If they are missing, the setup will create them with appropriate permissions
- * `cache/`
- * `config/`
- * `static/download/`
- * `static/widgets/`
- * `static/js/`
- * `static/uploads/`
- * `static/images/wow/`
- * `datasets/`  
- 
-#### 4. Extract the client archives (MPQs)
-Extract the following directories from the client archives into `setup/mpqdata/`, while maintaining patch order (base mpq -> patch-mpq: 1 -> 9 -> A -> Z). The required paths are scattered across the archives. Overwrite older files if asked to.  
+
+- `cache/`
+- `config/`
+- `static/download/`
+- `static/widgets/`
+- `static/js/`
+- `static/uploads/`
+- `static/images/wow/`
+- `datasets/`
+
+### 4. Extract the client archives (MPQs)
+
+Extract the following directories from the client archives into `setup/mpqdata/`,
+while maintaining patch order (base mpq -> patch-mpq: 1 -> 9 -> A -> Z).
+The required paths are scattered across the archives. Overwrite older files if asked to.  
+
+```sh
+WOW_DIR='/.../World Of Warcraft 3.3.5a'
+OUT_DIR='/.../aowow/setup/mpqdata'
+locale='enUS'
+
+mkdir -p "$OUT_DIR"
+MPQExtractor -f -c -o "$OUT_DIR" "$WOW_DIR/Data/common.MPQ" -e "*"
+MPQExtractor -f -c -o "$OUT_DIR" "$WOW_DIR/Data/common-2.MPQ" -e "*"
+MPQExtractor -f -c -o "$OUT_DIR" "$WOW_DIR/Data/expansion.MPQ" -e "*"
+MPQExtractor -f -c -o "$OUT_DIR" "$WOW_DIR/Data/lichking.MPQ" -e "*"
+MPQExtractor -f -c -o "$OUT_DIR" "$WOW_DIR/Data/patch.MPQ" -e "*"
+MPQExtractor -f -c -o "$OUT_DIR" "$WOW_DIR/Data/patch-2.MPQ" -e "*"
+MPQExtractor -f -c -o "$OUT_DIR" "$WOW_DIR/Data/patch-3.MPQ" -e "*"
+MPQExtractor -f -c -o "$OUT_DIR" "$WOW_DIR/Data/$locale/backup-$locale.MPQ" -e "*"
+MPQExtractor -f -c -o "$OUT_DIR" "$WOW_DIR/Data/$locale/base-$locale.MPQ" -e "*"
+```
+
    .. for every locale you are going to use:
    > \<localeCode>/DBFilesClient/  
    > \<localeCode>/Interface/WorldMap/  
@@ -87,16 +110,86 @@ Extract the following directories from the client archives into `setup/mpqdata/`
    > \<localeCode>/Interface/Glues/Loadingscreens/  
    > \<localeCode>/Interface/Glues/Credits/  
 
-#### 5. Reencode the audio files
+### 5. Reencode the audio files
+
 WAV-files need to be reencoded as `ogg/vorbis` and some MP3s may identify themselves as `application/octet-stream` instead of `audio/mpeg`.  
  * [example for WIN](https://gist.github.com/Sarjuuk/d77b203f7b71d191509afddabad5fc9f)  
  * [example for \*nix](https://gist.github.com/Sarjuuk/1f05ef2affe49a7e7ca0fad7b01c081d)
 
-#### 6. Run the initial setup from the CLI
-`php aowow --setup`.  
+### 6. Run the initial setup from the CLI
+
+```sh
+php aowow --setup
+```
+
 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.
 
+## Run with Docker
+
+Configure settings for first time:
+
+1. Create environment settings files:
+   ```sh
+   cp .env.aowow.dist .env.aowow
+   cp .env.mysql.dist .env.mysql
+   ```
+   Typically, `.env.mysql` is not required for production, because database server is hosted somewhere outside the docker.
+
+   > [!NOTE]
+   > You don't need to change `config/config.php` file, it will be overwritten with a special file, which
+   > takes required credentials from the environment. See `docker/aowow/src/config/config.php` for details.
+2. Edit `.env.*` files according to your environment, or leave as-is if environment is development.
+3. Optionally: setup path to mpqdata for `aowow` service in `compose.dev.yaml` file:
+   Replace this part of code:
+   ```yaml
+   # fixme optionally: change to directory with extracted mpq data
+   - setup_aowow:/var/www/html/setup/mpqdata:rw
+   # - /Users/md/Downloads/aowow-data/setup/mpqdata:/var/www/html/setup/mpqdata:ro
+   ```
+   with this (change `/.../aowow/setup/mpqdata` to path with your actual data):
+   ```yaml
+   - /.../aowow/setup/mpqdata:/var/www/html/setup/mpqdata:ro
+   ```
+
+Run application:
+
+```sh
+## for development:
+docker compose up -f compose.yaml -f compose.dev.yaml
+
+## for production:
+docker compose up
+```
+
+> [!NOTE]
+> First launch starts application initialization (database dumps download, loading dumps into database, downloading game data, extract media/info, etc ...)
+> It may take long time (up to 30 minutes and more). Please, be patient.
+> 
+> If it's required to skip initialization at first launch, then set `SETUP_SKIP` option value to `1`.
+
+Then web-application should be accessible at <http://172.28.0.10>.
+
+> [!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.
+
+Rebuild only aowow service (don't wipe database data):
+
+```sh
+docker container rm aowow-aowow-1
+docker volume rm aowow_setup_aowow 
+docker compose -f compose.yaml -f compose.dev.yaml up --build  
+```
+
+Full rebuild (wipe all data):
+
+```sh
+docker container rm aowow-mysql-1 aowow-aowow-1 
+docker volume rm aowow_data_mysql aowow_data_aowow aowow_setup_aowow 
+# docker volume rm aowow_setup_mysql  # ... contains trinitycore SQL dumps, typically it's never required to be removed 
+docker compose -f compose.yaml -f compose.dev.yaml up --build  
+```
 
 ## Troubleshooting