ARM Your Xyzzy

This image is based on the :latest or :3 tag from emcniece/DockerYourXyzzy

Get your Xyzzy on: docker pull ryaniskira/armyourxyzzy:latest

Github: Ryaniskira/ArmYourXyzzy
Docker Hub: Ryaniskira/armyourxyzzy

Supported tags and respective `Dockerfile` links:

Not yet

What is ARM Your Xyzzy?

This is a containerized build of the Pretend You're Xyzzy Cards Against Humanity clone built to run on ARM64/aarch64 platforms such as the Raspberry Pi 4.

⚠ Version 3 (April 2020) is a vastly simplified Docker image, may break if upgrading from version 2. It no longer features multi-step builds.

Usage

The PYX project can be used in Docker format for development, outputting the built files, or running in production.

Run with Docker-Compose (fastest)

An example stack of PYX with a Postgres database and an Ngrok tunnel can be found in docker-compose.yml:

# Run PYX/Postgres stack
docker-compose up -d --build

Once the containers are running, you can:

Visit http://localhost:8080/game.jsp to play locally
Visit http://localhost:4040/status to find your Ngrok URL
Visit https://#####.ngrok.io to share publicly
Add extra cards via https://github.com/ajanata/PretendYoureXyzzy/wiki/Cardcast

Run Standalone Container

Keep the container up with SQLite and war:exploded jetty:run:

docker run -d \
  -p 8080:8080 \
  --name pyx-dev \
  emcniece/dockeryourxyzzy:latest

# Visit http://localhost:8080 in your browser
# Or, start a bash session within the container:
docker exec -it pyx-dev bash

Run With Overrides

Settings in build.properties can be modified by passing them in the container CMD:

docker run -d \
  -p 8080:8080 \
  emcniece/dockeryourxyzzy:latest \
  mvn clean package war:war \
    -Dhttps.protocols=TLSv1.2 \
    -Dmaven.buildNumber.doCheck=false \
    -Dmaven.buildNumber.doUpdate=false \
    -Dmaven.hibernate.url=jdbc:postgresql://postgres/pyx

Building

This project can be built and run by any of the 3 following methods: CLI docker build commands, CLI make commands, or Docker-Compose.

Build via `make`

The Makefile documents the frequently used build commands:

# Build default (full / runtime) image
make image

# Run container
make run

# Run in debug mode (no container CMD):
make run-debug

Build via `docker build`

Docker commands can be found in the Makefile:

# Build full/runtime image
docker build -t pyx

Build via Docker-Compose

Force building with the --build flag:

# Run PYX/Postgres stack
docker-compose up -d --build

RyanHakurei/ArmYourXyzzy