Uchu Docker

Docker setup for running the Uchu Lego Universe server

Requirements

• Docker
• Docker Compose (a version that supports at least docker-compose v3.3 files)
• LU unpacked client with LCDRs TcpUdp mod
• Bash (macOS / Linux) or PowerShell (Windows)

Setup

Downloading the source

Clone the repository recursively, so that the Uchu source is also pulled:

git clone [email protected]:UchuServer/UchuDocker.git --recursive -b master

Setting up your environment

Copy the .env.sample file to .env:

cp .env.sample .env

Set the GAME_FOLDER variable in the .env file to the absolute path to the /res folder in your unpacked LU game folder using a text editor of your choice.

Setting up data storage

Create a data folder which will store your database files to ensure no loss of data:

mkdir pg-data

Running

docker-compose build
docker-compose up -d

This runs Uchu in the background along with Postgres. You can attach to the Uchu.Master shell using:

docker attach uchudocker_uchu_1

This allows you to input shell commands like /adduser <username>. You can exit the shell using Ctrl+P + Ctrl+Q (Don't use Ctrl+C: it closes the container, not just your session).

Closing

docker-compose down

Applying changes to .env

When applying any changes to the .env file after your initial docker-compose up -d, the changes aren't built into the container. Run docker-compose build --no-cache to apply your .env file changes after which docker-compose up -d can be to start up Uchu.

Adminer

Uchu Docker can also run Adminer, which allows you to easily modify the Uchu database in a user friendly way. You can activate this by uncommenting the lines after # Uncomment this if you wish to use adminer in docker-compose.yaml, note that you probably don't need this by default but can assist with more user friendly database management. Select the PostgreSQL database type, set the server to db and enter the credentials found in the .env file to login. More info on how to use Adminer can be found on their website.

Hosting (Advanced)

This Docker setup can be used to host Uchu as long as all ports are exposed (see the .env.sample file for all ports that need to be exposed). Use your firewall to port forward these ports and incoming connections should be forwarded to Uchu. Do note that hosting Uchu on anything other than localhost requires a valid PFX certificate from a trusted CA like Let's Encrypt and therefore also a valid domain name.

You cannot use a self signed certificate even if you first generate your own root certificate: the TcpUdp mod does not look at the OS certificate store for valid root certificates. You can add a certificate to the container by adding it to this directory under the name cert.pfx. Finally set the HOSTNAME variable in the .env file to the domain name for your certificate.