~mser/vmangos-docker

ref: 48065c3cb48745a5c517212abc7529946f876baa vmangos-docker/README.md -rw-r--r-- 6.2 KiB
48065c3cMichael Serajnik Fix repository path determination under macOS 4 months ago

#vmangos-docker

A Docker setup for VMaNGOS

This is a simple Docker setup for VMaNGOS. It is heavily inspired by tonymmm1/vmangos-docker, which has some good ideas, but, in my opinion, falls a bit flat in execution.

In particular, I did not like the convoluted Python script used to control everything, the lack of an easy way to back up the databases, a missing built-in solution to extract client data and the fact that all the containers are executed as root, causing potential security issues and permission headaches on the host; among other, more minor things.

#Install

#Dependencies

  • Docker
  • Docker Compose
  • A POSIX-compliant shell as well as various core utilities (such as cp and rm) if you intend to use the provided scripts to install, update and manage VMaNGOS

#Preface

This assumed client version is 5875 (patch 1.12.1); if you want to set up VMaNGOS to use a different version, search the provided 00-prefixed scripts for occurrences of client_version=5875 and modify them accordingly. You will also have to adjust the ./src/data/5875:/opt/vmangos/bin/5875:ro bind mount for the vmangos_mangos service in ./docker-compose.yml accordingly.

The user that is used inside the containers has UID 1000 and GID 1000 by default. You can adjust this, if needed; e.g., to match your host UID/GID. This requires searching the scripts for user_id=1000 and group_id=1000 and modifying these values as well as adjusting the environment variables VMANGOS_USER_ID and VMANGOS_GROUP_IDin ./docker-compose.yml.

#Instructions

First, clone the repository, initialize the submodules and generate the config files:

user@local:~$ git clone https://git.sr.ht/~mser/vmangos-docker
user@local:~$ cd vmangos-docker
user@local:vmangos-docker$ git submodule update --init --remote --recursive
user@local:vmangos-docker$ ./00-create-or-reset-config-files.sh

At this point, you have to adjust the two configuration files in ./config as well as ./docker-compose.yml for your desired setup. The default setup will only allow local connections (from the same machine). To make the server public, it is required to change the VMANGOS_REALM_IP environment variable for the vmangos_database service in ./docker-compose.yml. Simply replace 127.0.0.1 with the server's WAN IP (or LAN IP, if you don't want to make it accessible over the Internet).

VMaNGOS also requires some data generated/extracted from the client to work correctly. To generate that data automatically during the installation, copy the contents of your World of Warcraft client directory into ./src/client_data.

After that, simply execute the installer:

user@local:vmangos-docker$ ./00-install.sh

Note that generating the required data will take many hours (depending on your hardware). Some notices/errors during the generation are normal and nothing to worry about.

Alternatively, if you have acquired the extracted/generated data previously, you can place it directly into ./src/data, in which case the installer will skip extracting/generating the data.

After the installer has finished, you should have a running installation and can create your first account by attaching to the vmangos_mangos service:

user@local:vmangos-docker$ docker attach vmangos_mangos

After attaching, create the account and assign an account level:

account create <account name> <account password>
account set gmlevel <account name> <account level> # see https://github.com/vmangos/core/blob/79efe80ae39d94a5e52b71179583509b1df75899/src/shared/Common.h#L184-L191

When you are done, detach from the Docker container by pressing Ctrl+P and Ctrl+Q.

#Usage

For your convenience, a number of shell scripts are provided to keep managing your VMaNGOS installation simple, without requiring detailed knowledge about how VMaNGOS or Docker work.

These scripts are all in the root directory of this repository and prefixed with 00 (so they are grouped together when viewing the directory).

I recommend taking a look at them to understand how they work and, if needed, modifying them to better suit your needs.

#Starting and stopping VMaNGOS

VMaNGOS can be started and stopped using the following scripts:

user@local:vmangos-docker$ ./00-start.sh
user@local:vmangos-docker$ ./00-stop.sh

#Updating

Updating can be done via the provided update script. This will update the submodules, rebuild the Docker images and run databases migrations:

user@local:vmangos-docker$ ./00-update.sh

If the update script fails with the notice that there is new world database import, simply follow the instructions that are also printed in such a case.

At times, this repository might also get updated. Please do not blindly run git pull without looking at the commits to see what (potentially breaking) changes have been introduced.

#Creating a database backup

The three important databases VMaNGOS uses, mangos, characters and realmd, can be exported as SQL dumps with the following script:

user@local:vmangos-docker$ ./00-create-database-backup.sh

The dumped databases can, by default, be found in ./backup. If you want to change that path, adjust the ./backup:/backup bind mount for the vmangos_database service in ./docker-compose.yml accordingly.

#Extracting client data

If at any point after the initial installation you need to re-extract the client data, you can do so by running the following script:

user@local:vmangos-docker$ ./00-extract-client-data.sh

Note that this will also remove any existing data in ./src/data, so make sure to create a backup of that in case you want to save it.

#Maintainer

Michael Serajnik

#Contribute

You are welcome to help out!

Open a ticket or send a patch.

#License

AGPL-3.0-or-later © Michael Serajnik