Dockerfile

# lostcityrs-docker
# Copyright (C) 2025-2026  Michael Serajnik  https://github.com/mserajnik

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.

# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

ARG DEBIAN_FRONTEND=noninteractive
ARG LOST_CITY_RS_VERSION=254
ARG LOST_CITY_RS_ENGINE_REPOSITORY=https://github.com/LostCityRS/Engine-TS.git
ARG LOST_CITY_RS_CONTENT_REPOSITORY=https://github.com/LostCityRS/Content.git
ARG LOST_CITY_RS_USER_ID=1000
ARG LOST_CITY_RS_GROUP_ID=1000
ARG LOST_CITY_RS_USER_NAME=lostcityrs
ARG LOST_CITY_RS_GROUP_NAME=lostcityrs

FROM oven/bun:debian

ARG TARGETARCH
ARG DEBIAN_FRONTEND
ARG LOST_CITY_RS_VERSION
ARG LOST_CITY_RS_ENGINE_REPOSITORY
ARG LOST_CITY_RS_CONTENT_REPOSITORY
ARG LOST_CITY_RS_USER_ID
ARG LOST_CITY_RS_GROUP_ID
ARG LOST_CITY_RS_USER_NAME
ARG LOST_CITY_RS_GROUP_NAME

# The Docker setup that this Dockerfile is part of is limited to the following
# scope:
# - A single world.
# - SQLite as the database backend.
# - Usage of the web client (it is not intended to expose ports other than the
#   web client port).
# - Accounts can be directly created through the web client (this means that to
#   disable public access, the web client has to be access-protected by other
#   means, e.g., a reverse proxy with HTTP basic authentication).
#
# Other configurations are probably possible, but not tested and unsupported.
# As such, we only set a limited set of environment variables here to ensure
# that the setup works out of the box (and rely on the defaults for everything
# else).
ENV WEB_PORT=8888
ENV NODE_PRODUCTION=true
ENV NODE_DEBUG=false
ENV DB_BACKEND=sqlite
ENV WEBSITE_REGISTRATION=false
ENV LOGIN_SERVER=true
ENV LOGIN_HOST=localhost
ENV LOGIN_PORT=43500
ENV FRIEND_SERVER=true
ENV FRIEND_HOST=localhost
ENV FRIEND_PORT=45099
ENV LOGGER_SERVER=true
ENV LOGGER_HOST=localhost
ENV LOGGER_PORT=43501
ENV EASY_STARTUP=true
# Husky is not needed here since it is only used for pre-commit hooks.
ENV HUSKY=0

RUN \
  apt update && \
  apt install -y --no-install-recommends \
    curl \
    git \
    netcat-openbsd \
    openjdk-21-jdk && \
  # The Debian-based Bun Docker image has a user called `bun` with UID 1000 and
  # GID 1000 by default. Since we allow configuration of the name, UID and GID
  # of the user and group that should be used in the container, we need to
  # either rename the existing user and group or create a new user and group
  # with the specified name, UID and GID.
  cd /tmp && \
  existing_group=$(getent group "$LOST_CITY_RS_GROUP_ID") || true && \
  existing_user=$(getent passwd "$LOST_CITY_RS_USER_ID") || true && \
  if [ -n "$existing_group" ]; then \
    old_groupname=$(echo "$existing_group" | cut -d':' -f1) && \
    groupmod -n "$LOST_CITY_RS_GROUP_NAME" "$old_groupname"; \
  else \
    groupadd -g "$LOST_CITY_RS_GROUP_ID" "$LOST_CITY_RS_GROUP_NAME"; \
  fi && \
  if [ -n "$existing_user" ]; then \
    old_username=$(echo "$existing_user" | cut -d':' -f1) && \
    usermod -l "$LOST_CITY_RS_USER_NAME" -d "/home/$LOST_CITY_RS_USER_NAME" "$old_username" && \
    mv "/home/$old_username" "/home/$LOST_CITY_RS_USER_NAME"; \
  else \
    useradd -u "$LOST_CITY_RS_USER_ID" -g "$LOST_CITY_RS_GROUP_NAME" -d "/home/$LOST_CITY_RS_USER_NAME" -s /bin/sh -m "$LOST_CITY_RS_USER_NAME"; \
  fi && \
  mkdir -p /opt/lostcityrs && \
  git clone "$LOST_CITY_RS_ENGINE_REPOSITORY" --single-branch --depth=1 -b "$LOST_CITY_RS_VERSION" /opt/lostcityrs/engine && \
  git clone "$LOST_CITY_RS_CONTENT_REPOSITORY" --single-branch --depth=1 -b "$LOST_CITY_RS_VERSION" /opt/lostcityrs/content && \
  chown -R $LOST_CITY_RS_USER_NAME:$LOST_CITY_RS_GROUP_NAME /opt/lostcityrs && \
  # See https://github.com/boxboat/fixuid
  curl -SsL https://github.com/boxboat/fixuid/releases/download/v0.6.0/fixuid-0.6.0-linux-$TARGETARCH.tar.gz | tar -C /usr/local/bin -xzf - && \
  chown root:root /usr/local/bin/fixuid && \
  chmod 4755 /usr/local/bin/fixuid && \
  mkdir -p /etc/fixuid && \
  printf 'user: %s\ngroup: %s\n' "$LOST_CITY_RS_USER_NAME" "$LOST_CITY_RS_GROUP_NAME" > /etc/fixuid/config.yml && \
  apt remove -y \
    curl && \
  apt autoremove -y && \
  apt clean -y && \
  rm -rf /var/lib/apt/lists/*

COPY --chmod=755 ./docker-cmd-start.sh /usr/local/bin/start

USER $LOST_CITY_RS_USER_NAME

# Lost City RS uses fixed paths for the SQLite database files in the `engine`
# directory. We create a `database` directory and symlink the files from there,
# allowing the database to be persisted via a bind mount or volume.
# WAL mode is currently not used by default, but we create the required
# symlinks anyway for future-proofing.
RUN \
  mkdir /opt/lostcityrs/database && \
  for suffix in "" "-journal" "-shm" "-wal"; do \
    ln -sn "/opt/lostcityrs/database/db.sqlite$suffix" "/opt/lostcityrs/engine/db.sqlite$suffix"; \
  done && \
  cd /opt/lostcityrs/engine && \
  bun install

WORKDIR "/home/$LOST_CITY_RS_USER_NAME"
CMD ["start"]