Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

The game server is called cq-server and is (currently) only available as a container image. To pull the container image user one of the following commands:

# podman pull codeberg.org/corridor-quest/cq-server
# docker pull codeberg.org/corridor-quest/cq-server

cq-server requires a bunch of environment variables to be set up. It depends on your container runtime how to set these up. Some of these you should regards as secrets.

You find all the environment variables here. Most have default values.

Database

cq-server expects an empty postgreSQL database and an account within PostGreSQL thas has write access ti this database and is able to run migrations.

Email

cq-server needs to be able to send e-mails for various functionality, among some critical functions like sending verification codes for signing up, etc.

Tested versions:

  • PostGreSQL: v18
  • ntfy.sh: ?