ACE Hosting Docker

This guide assumes that you're familiar with Docker its concepts and its usage.

For your convenience, we have in our repo a simple docker-compose.yml to make use of our docker container build.

Using the docker-compose.yml along with the below instructions are not sufficient on its own. Environment variables config file and DAT files must also be setup before starting the container. Even for non-Raspberry PI hosts, these additional details necessary for any instance running in docker can be found in the Raspberry Pi instructions for an example of standing up a dockerized version of ACEmulator.

Start ACE

docker compose up -d

To access the ACE console

docker container attach --sig-proxy=false ace-server

To access the docker compose logs

docker compose logs -f

Restart ACE

docker compose restart

Stop ACE

docker compose down

Update ACE to latest released master

docker compose down
docker compose pull
docker compose up -d

Troubleshooting

Error failed to read dockerfile: open Dockerfile: no such file or directory

This can occur when starting the container in some tools, such as the VSCode Docker extension, which automatically generates a --build parameter for the Compose Up option. The docker-compose.yml includes the following:

  ace-server:
    build: .
    image: acemulator/ace:latest

This assumes the file https://github.com/ACEmulator/ACE/blob/master/Dockerfile is present in the current directory (as indicated by . shorthand for currenty directory). Typically for server hosting you would not have a Dockerfile file present, as you only copy docker-compose.yaml, docker.env, and Dat files. (Typically only emulator developers building the ACE server from source code need the build: parameter with the Dockerfile).

Solution: Comment out build: . in the docker-compose.yaml. Rather then build from source, the image: reference is already sufficient to pull the pre-built image of the server:

  ace-server:
    # build: .
    image: acemulator/ace:latest