Ansible Collection AzerothCore

Deploys an AzerothCore Docker environment using the official acore-docker project. The collection automates cloning the required repositories, building custom server images, deploying the Docker Compose stack, and optionally custom modules (Indvidiual Progression is included by default).

This project has no affiliation with AzerothCore.

Features

• Clone the official acore-docker repository.
• Build custom AzerothCore server images from source.
• Build and optionally push images to a Docker registry.
• Deploy the Docker Compose stack.
• Mount custom modules and configuration.
• Support the Individual Progression module by default.
• Includes playbooks for common build and deployment workflows.

Requirements

The target host should have:

• Docker
• Docker Compose
• Git
• Sufficient disk space for building AzerothCore images.

If image pushing is enabled, a Docker registry is also required. By default, the collection assumes a registry is available on the Ansible control host on port 5000.

This playbook requires root privleges. You can pass in a root password with --become-pass-file or by enabling passwordless-sudo.

Usage

Deployment

Runs the complete deployment workflow:

1. Prepare the acore-docker project.
2. Configure AzerothCore modules.
3. Optionally build custom images (required for module support).
4. Deploy the Docker Compose stack.
5. Manage users on AzerothCore (may be buggy).

To download the latest version of the collection:

ansible-galaxy collection install holliefae.azerothcore

Alternatively define in a requirements file:

collections:
  - name: holliefae.azerothcore

Ensure your desired host is a member of thr azerothcore inventory group (e.g):

[azerothcore:children]
laptop

[laptop]
localhost

To initiate the deployment run the collection playbook:

ansible-playbook holliefae.azerothcore.deploy

Image build

Builds custom AzerothCore images without deploying the Docker Compose stack.

ansible-playbook holliefae.azerothcore.build

Post deployment

Skip the full deploy pipeline to reconfigure an active server.

ansible-playbook holliefae.azerothcore.post_configure

Example Configuration

Example config for a basic deployment. (Ensure you encrypt secrets with Vault).

azerothcore_build_images: false
azerothcore_install_db_pwd: "<password>"
azerothcore_install_assets_path: "<path_to_asset_data>"

azerothcore_user_bootstrap_password: "<password>"
azerothcore_user_list:
  user1:
    enabled: true
    password: "<password>"
    gmlevel: 1
  user2:
    enabled: false
    password: "<password>"
  admin:
    enabled: true
    password: "<password>"
    gmlevel: 3

Roles

azerothcore_install

Prepares the AzerothCore Docker project. This role clones the upstream acore-docker repository, creates the required directory structure, and writes the generated Docker Compose configuration.

Variables

Variable	Description
azerothcore_install_path	Docker Compose project directory.
azerothcore_install_modules_path	Directory containing AzerothCore modules.
azerothcore_install_config_path	Server configuration directory.
azerothcore_install_assets_path	Client data directory.
azerothcore_install_phpmyadmin_port	Port where phpMyAdmin will be exposed.
azerothcore_install_db_pwd	MariaDB root password. Required.
azerothcore_install_compose_repository	Upstream acore-docker repository.
azerothcore_install_compose_repository_version	Version/ref of the upstream repository.
azerothcore_install_compose_repository_path	Path where acore-docker will be cloned.
azerothcore_install_compose_overrides	Overrides applied to the generated runtime Compose configuration.

azerothcore_modules

Manages AzerothCore modules, including optional support for the Individual Progression module. (Set azerothcore_modules_default_dictionary to {} to disable IP).

Variables

Variable	Description
azerothcore_modules_progression_repository	Progression module repository.
azerothcore_modules_progression_version	Progression module version/ref.
azerothcore_modules_progression_phase	Progression phase to configure.
azerothcore_modules_default_dictionary	Default dictionary of modules (IP).
azerothcore_modules_extra_dictionary	Extra dictionary of modules (add new modules to this).
azerothcore_modules_dictionary	Use this to override the default modules.

azerothcore_build

Builds custom AzerothCore Docker images and optionally pushes them to a Docker registry.

Variables

Variable	Description
azerothcore_build_images	Whether images should be built.
azerothcore_build_repository	AzerothCore source repository.
azerothcore_build_version	AzerothCore source version/ref.
azerothcore_build_repository_path	Path where the source repository will be cloned.
azerothcore_build_push_images	Push images after building.
azerothcore_build_image_tag	Image tag applied to built images.
azerothcore_build_registry_address	Docker registry address.
azerothcore_build_registry_port	Docker registry port.
azerothcore_build_compose_overrides	Overrides applied to the generated builder Compose configuration.
azerothcore_build_images_list	List of images to build (Default is worldserver, authserver and db-import)

azerothcore_user

Manages AzerothCore users, including support for creating users and managing GM status.

Variables

Variable	Description
azerothcore_user_enable	Enable the user role.
azerothcore_user_list	Dictionary (ironically not a list) of users.
azerothcore_user_soap_address	URL of the WorldServer SOAP server.
azerothcore_user_soap_username	SOAP credential used during user creation.
azerothcore_user_soap_password	SOAP credential used during user creation.
azerothcore_user_enable_bootstrap	Whether to enable the creation of bootstrap user.
azerothcore_user_bootstrap_username	Bootstrap username.
azerothcore_user_bootstrap_password	Bootstrap password. Required.

azerothcore_realmlist

Manages AzerothCore realmlist. Only supports the default realm currently.

Variables

Variable	Description
azerothcore_realmlist_enable	Enable the realmlist role.
azerothcore_realmlist_name	Name of the default realm.
azerothcore_realmlist_address	Address of the default realm.
azerothcore_realmlist_local_address	Local address of the default realm.
azerothcore_realmlist_port	Default WorldServer port.

azerothcore_deploy

Manages AzerothCore deployment. See the Compose Module for more information.

Variables

Variable	Description
azerothcore_deploy_state	State of the compose project. (Default 'present').
azerothcore_deploy_rebuild	Rebuild condition of the compose project.

Dependencies

This collection depends on:

• ansible.posix
• community.docker
• ansible.mysql

Ensure pymysql is installed in your virtual environment.

License

GPL-3.0-only

Notes

AI (specifically ChatGPT) was used to help make this README as I struggle with writing documentation.