D2 Armory

This repository consists of the parts required to run the D2 armory with docker compose.

The docker-compose.yml file describes all components and their configuration.

Modules

• armory gui
• armory api

Armory UI

The Armory frontend written in react that can be found here.

Armory API

Armory API is responsible for serving characters over HTTP and caches characters requested repeatedly in a short time in mongoDB.

D2S folder

the d2s folder contains a few d2s files that can be used to run the armory with. The d2s folder is mounted into the d2 armory api on start up.

How to use the repository

The armory is started using docker compose to containerize the application so the host system doesn't have to install any dependencies.

Start the armory

# starts the armory as with all components as daemons.
docker-compose up -d

Health check

# list all running containers to make sure they're healthy.
docker-compose ps

Stop the armory

# stops all components.
docker-compose down

Stop and remove the data volume (character cache)

# use the -v flag to remove the volume.
docker-compose down -v

Stop single container

If you want to develop a single part of the armory such as the frontend, it's advised to run that project outside of docker by cloning the repository and start it locally on the host machine but still use the Armory API and mongodb running in Docker.

docker-compose stop armory-gui