Complete rework

.dockerignore

@@ -1,2 +1,8 @@
-live/
-README.md
+test/
+.gitignore
+.editorconfig
+examples/
+LICENSE
+linuxgsm-docker.sh
+*.md
+

.editorconfig

@@ -0,0 +1,13 @@
+# EditorConfig helps developers define and maintain consistent coding styles between different editors and IDEs.
+# Atom: Please assure your Atom's config setting Tab Type is set to auto, otherwise Atom-EditorConfig may not work as expected. Also disable whitespace package.
+# http://editorconfig.org/
+
+root = true
+
+[*]
+charset = utf-8
+indent_style = tab
+indent_size = 4
+trim_trailing_whitespace = true
+end_of_line = lf
+insert_final_newline = true

.gitignore

@@ -1 +1,5 @@
 *~
+test/*results*
+**/*.log
+test/steam_test_credentials
+*.patch

DEVELOPER.md

@@ -0,0 +1,34 @@
+# Overview for developers and consumers of the image
+
+If you want to work on this files at all, check/use: `init_dev_environment.sh`. E.g. it will check for tools you need or prevent your steam credentials to be committed
+
+Repository contains:
+- docker build scripts `/build`, sometimes usable by extending dockerimages
+- runtime scripts `/runtime`, intended to be used by extending dockerimages and available in PATH
+- test scripts `/test`
+
+Please check and use  its telling you if you need to install tools and prevents commiting your steam credentials by accident.
+
+## features
+
+- lgsm commands are available in PATH so you can directly use them e.g. `lgsm-update` which is the same as `update`
+- We are using [Gosu](https://github.com/tianon/gosu) so entrypoint is executed as root but every command is executed with lower user privilege.
+  - Because the commands take care of gosu, you can use `lgsm-update` in your custom scripts as root and the command will take care of correct user
+  - Also works if you are using: `docker exec -it CONTAINER update`
+- `/runtime` contains scripts(refered to as commands of the image) which provide standard functions, also available in PATH so you can directly invoke them
+  - `lgsm-fix-permission` resets all file permissions in volume
+  - `lgsm-update-uid-gid` update uid / gid of lgsm user and all owned files 
+  - `lgsm-init` resets linuxgsm.sh in volume and installs _servercode_.sh
+  - Cron job handling via Supercronic `lgsm-cron-init` `lgsm-cron-start`
+- _alpha state_ `lgsm-load-config` updates gameconfig according to environment variables
+
+## dockerimage folder structure
+
+- `/home/linuxgsm/`
+    - home folder of linuxgsm user
+    - volume for linuxgsm installation
+- `/home/linuxgsm-scripts`
+    - contains all scripts and links and is part of PATH variable, so all scripts are directly accessible from everywhere
+        - initial linuxgsm.sh
+        - links to lgsm commands like `lgsm-monitor` which is identical to `monitor`
+

README.md

@@ -11,38 +11,66 @@
 A dockerised version of LinuxGSM https://linuxgsm.com
 Dockerhub https://hub.docker.com/r/gameservermanagers/linuxgsm-docker/
 
-# How to Use
+## How to use:
 
-## Create Persistant Storage
-Game servers require persistant storage to store the server files and configs. The docker reccomended way is to use Persistant storage
+1. Choose your servercode and replace in below
+2. start `docker-compose -f examples/SERVER.yml up -d`, if the server needs credentials there will be placeholders in the compose.
+3. get config location `docker exec -it lgsm-SERVER-1 details`
+4. copy your own config into: `docker cp my_local_config.txt lgsm-SERVER-1:/config_location_from_step_3`
+5. print config content `docker exec lgsm-SERVER-1 cat /config_location_from_step_3`
+6. stop with:
+    - Stopping container and keep files `docker-compose -f examples/SERVER.yml down` or `docker stop lgsm-SERVER-1`
+    - Stopping container and remove files `docker-compose -f examples/SERVER.yml down --volumes`
 
-```
-docker volume create csgoserver
-```
+## Overview
 
-# Install and Start Game server
-```
-docker run -d --name csgoserver -v csgoserver --net-host -it -env GAMESERVERNAME=csgoserver gameservermanagers/linuxgsm-docker
-```
-# Run LinuxGSM commands
-Commands can be run just like standard LinuxGSM using the docker exec command.
-```
-docker exec -it csgoserver ./csgoserver details
-```
-# Edit LinuxGSM config
-To edit the LinuxGSM config files use the following.
+- build with `./test/single.sh --build-only servercode`
+- test with `./test/single.sh servercode`
+- get help `./test/single.sh --help`
+- LinuxGSM monitor executed every few seconds as health check
+- `docker stop CONTAINER` is redirected to lgsm-stop
+- `docker logs CONTAINER` show the game server log
+- `docker exec -it CONTAINER --help` every linuxgsm command is available in two forms e.g. `lgsm-update` and `update`. Available commands differ for different servercodes.
+- [Repository / Container / Dev structure documentation](DEVELOPER.md)
+- [How to build this / How to use it for lgsm testing](test/testing.md)
 
-View the default settings
-```
-docker exec -it csgoserver nano _default.cfg
-```
-Edit LinuxGSM config settings
-```
-docker exec -it csgoserver nano common.cfg
-```
-Edit Game Server Config settings
-To edit the game server config settings run the following.
+### How to configure LinuxGSM in docker?
 
-```
-docker exec -it csgoserver nano server.cfg
+You can configure LinuxGSM and some gameservers(alpha state) with environment variables directly.
+E.g. you want to set steamuser / steampass which is a LinuxGSM option:
+- `CONFIG_steamuser=...` its checked if this variable exists before its set, container will exit very early if the configuration option isn't already part of _default.cfg
+- `CONFIGFORCED_steamuser=...` The variable will be set always, no check done.
+- These options will be written to the instance.cfg, thereforce you can use it to set options like `CONFIG_startparameters`, `CONFIG_discordalert` and so on.
+
+### How to use cronjobs?
+You can create cron jobs with environment variables. `CRON_update_daily=0 7 * * * update` will create a cronjob which will check for updates once a day. 
+
+### Example ahl2server yml:
+```yml
+volumes:
+  ahl2server-files:
+
+name: lgsm
+
+services:
+  ahl2server:
+    image: "gameservermanagers/linuxgsm-docker:ahl2server"
+    tty: true
+    restart: unless-stopped
+    environment:
+      - "CRON_update_daily=0 7 * * * update"
+      - "CONFIGFORCED_steamuser=MySteamName"
+      - "CONFIGFORCED_steampass=my steam password"
+    volumes:
+      - ahl2server-files:/home/linuxgsm
+      - /etc/localtime:/etc/localtime:ro
+    ports:
+      # Game
+      - "27015:27015/udp"
+      # Query / RCON
+      - "27015:27015/tcp"
+      # SourceTV
+      - "27020:27020/udp"
+      # Client
+      - "27005:27005/udp"
 ```

build/Dockerfile

@@ -0,0 +1,87 @@
+# download / build / verify dependencies
+# own stage = additional deps needed which are only here used
+FROM ubuntu:22.04 as dependencyStage
+
+COPY build/installGosu.sh \
+	build/installOpenSSL_1.1.sh \
+	build/installSupercronic.sh \
+	/
+RUN chmod +x installGosu.sh
+RUN set -eux; \
+	./installGosu.sh 1.16; \
+	./installSupercronic.sh v0.2.2 8c509ffd2f4adfb722e388cc3ad65ac0baf5e69eb472e298144f50303216903d; \
+	./installOpenSSL_1.1.sh 1.1.1t
+
+# create linuxgsm image
+# this stage should be usable by existing developers
+FROM ubuntu:22.04 as linuxgsm
+
+ARG ARG_LGSM_VERSION="master"
+ENV LGSM_VERSION="${ARG_LGSM_VERSION:?}" \
+	LGSM_GAMESERVER="" \
+	LGSM_USE_GAMEDIG="true" \
+	LGSM_CONFIG_PATTERN_GAME="" \
+	USER_ID="750" \
+	GROUP_ID="750" \
+	LGSM_DEBUG="false" \
+	\
+	USER_NAME="linuxgsm" \
+	LGSM_PATH="/home/linuxgsm" \
+	LGSM_SCRIPTS="/home/linuxgsm-scripts" \
+	PATH="$PATH:/home/linuxgsm-scripts/" \
+	LANG="en_US.UTF-8" \
+	LANGUAGE="en_US.UTF-8" \
+	LC_ALL="en_US.UTF-8" \
+	TERM="xterm" \
+	SUPERCRONIC_CONFIG="/home/linuxgsm-scripts/cron.config" \
+	LGSM_STARTED="/home/linuxgsm/server.started" \
+	LGSM_CURRENT_COMMAND="/home/linuxgsm/lgsm-cmd.currently"
+
+COPY --from=dependencyStage \
+	/usr/local/bin/gosu \
+	/usr/local/bin/supercronic \
+	/usr/local/bin/
+COPY --from=dependencyStage \
+	/usr/local/lib \
+	/usr/local/lib/
+COPY build/installMinimalDependencies.sh \
+	build/setupUser.sh \
+	build/installLGSM.sh \
+	build/installGamedig.sh \
+	build/cleanImage.sh \
+	build/installServerDependencies.sh \
+	build/createAlias.sh \
+	\
+	runtime/entrypoint.sh \
+	runtime/lgsm-cron-init \
+	runtime/lgsm-cron-start \
+	runtime/lgsm-init \
+	runtime/lgsm-fix-permission \
+	runtime/lgsm-load-config \
+	runtime/lgsm-tmux-attach \
+	runtime/lgsm-update-uid-gid \
+	"$LGSM_SCRIPTS"/
+
+RUN set -eux; \
+	installMinimalDependencies.sh; \
+	setupUser.sh; \
+	installLGSM.sh; \
+	installGamedig.sh; \
+	cleanImage.sh
+
+VOLUME "$LGSM_PATH"
+WORKDIR "$LGSM_PATH"
+
+# install server specific dependencies
+FROM linuxgsm as specific
+ARG ARG_LGSM_GAMESERVER=""
+ENV LGSM_GAMESERVER="${ARG_LGSM_GAMESERVER:? To build the container by hand you need to set build argument ARG_LGSM_GAMESERVER to your desired servercode}"
+RUN set -eux; \
+	installServerDependencies.sh "$LGSM_GAMESERVER"; \
+	createAlias.sh "$LGSM_GAMESERVER"; \
+	cleanImage.sh
+
+HEALTHCHECK --start-period=3600s --interval=90s --timeout=900s --retries=3 \
+	CMD [ -f "$LGSM_STARTED" ] && lgsm-monitor || exit 1
+
+ENTRYPOINT ["./../linuxgsm-scripts/entrypoint.sh"]

build/cleanImage.sh

@@ -0,0 +1,21 @@
+#!/bin/sh
+
+# clean/shrink dockerimage and removes unnecessary files
+# e.g. remove apt cache and build scripts
+
+set -o errexit
+set -o nounset
+if "$LGSM_DEBUG"; then
+    set -o xtrace
+fi
+echo "[info][cleanImage] cleaning image"
+
+apt-get autoremove -y
+apt-get clean -y
+rm -rf /var/lib/apt/lists/* >> /dev/null 2>&1 || true
+rm -rf "${LGSM_PATH:?}"/* /tmp/* /var/tmp/* || true
+rm "$LGSM_SCRIPTS/installMinimalDependencies.sh" \
+    "$LGSM_SCRIPTS/installLGSM.sh" \
+    "$LGSM_SCRIPTS/installGamedig.sh" \
+    "$LGSM_SCRIPTS/setupUser.sh" \
+    "$LGSM_PATH"/* >> /dev/null 2>&1 || true