SCP: Secret Laboratory Dockerfile

Contents

• Summary
• Setup Guide
• Configuration
  • ENV Variables
  • Volumes & Mounts
• Example Compose

Summary

This is a fork of lsuvgs/scpsl-exiled which was created by me for the LSU Video game and ESports Society (LSUVES) during my term as technical officer (2023 - 2024). At this point, with the approval of the successor committee, I intend to maintain this repo as the official replacement for the one published under the lsuvgs account.

As with the original image, the primary goal of this image is to fix several issues that were present with our previous solution, namely t3l3tubie/scpsl. Secondarily, this image also aims to improve maintainability and eventually provide features that were not present in the original.

Unlike t3l3tubie/scpsl, this image is built from a general purpose ubuntu 20.04 base image, as this provides the correct version of GLibC (which I did not feel qualified enough to try and upgrade manually due to compatibility issues) while providing additional tools for inspection through the docker attach functionality.

On top of this, this image is also designed to allow for automatic updates, removing the need to manually pull a new image every time the game updates. This comes at the cost of a slightly longer boot sequence, however the worst of this can be addressed by holding steamcmd in a named volume.

Setup Guide

1. Ensure you have Docker installed and running on your system.
   • If you need to install Docker, please head to their website for instructions
2. Run docker pull doobig/scpsl-docker:latest or otherwise load the image.
   • Alternatively, download the .tar file and run docker load
3. (Optional) Create a new directory and docker-compose file for the server.
4. (Optional) Review environment variables and set any configurations neccesary.
   • See below for an example compose file and list of ENVs
5. Start the server with docker run or docker compose up if using docker-compose.
6. Wait and watch. Startup might take a while without any existing files.
   • Startup is typically faster if steamcmd and/or config files are made persistent.
7. (Optional) Ensure any peristent data (I.E Config files) are correctly mounted on the host system.
   • Config files may need to be regenerated after larger updates, as they can become outdated.

Configuration

ENV Variables

Variable	Description	Default Value
SCPSL_PORT	Sets the port variable for LocalAdmin on container start	7777
ENABLE_PATCH	Enables the patch applied to ensure functionality.	true

Volumes & Mounts

/config is provided as an easy to access symlink for /home/<user>/.config/ to provide a user agnostic mountpoint. This allows for easy persistence of all config files and/or plugins if appropriate.

• /config/SCP Secret Laboratory should contain all base game SCP:SL data
• /config/EXILED should contain all EXILED data. (W.I.P)

All volumes should be read/writable by GUID 22035 to ensure functionality

Example docker-compose.yml

version: '3'

services:
  server:

    image: doobig/scpsl-docker:latest
    container_name: scpsl

    restart: unless-stopped
    stdin_open: true
    tty: true

    ports:
      - "7777:7777"

    environment:
      SCPSL_PORT: 7777

    volumes:
#      - steamcmd:/home/scpsl/.steamcmd
      - ./scpsl-data:/config/SCP Secret Laboratory

#volumes:
#  steamcmd: