Skip to content

Latest commit

 

History

History
228 lines (177 loc) · 8.02 KB

README.md

File metadata and controls

228 lines (177 loc) · 8.02 KB
Raw

enshrouded_dedicated server toolset

Simple Shell script-set to "Monitor / Backup / Update" Enshrouded dedicated servers.


Overview

Server-Side:

  • enshrd_steamuser_check : collect server login/logout informations (every minutes), and convert steamID to Username.
  • enshrd_backupgrade + enshrd_query + a2squery.py : work together once a day to backup the server map and upgrade server core files with SteamCMD if needed (Optional: proton-update updates Proton-GE to latest version during the process).
  • enshrd-api : Flask API Endpoint for serving enshrd_query on port 8080 (password protected)
  • All the shell and python scripts need to be placed in the PATH of the "enshrouded user" that runs the server binary (enshrouded_server.exe).
  • The "Enshourded User" MUST have "sudo" properly configured for managing the Enshrouded Systemd Service during the Backup / Upgrade process (see "Sample Sudoer" at the end of this document).

Client-Side:

  • enshrd_query + a2squery.py scripts are used to get Enshrouded Server status, base informations, Enshrouded SVN Server version, and Steam Username(s) that are currently logged in to the server.


Details

enshrd_query + a2squery.py

enshrd_query -h

Server infos:
  -s|--server <Ip-Hostname>
  -p|--port   <query_port>

  exemple: "enshrd_query <server>:<port>"
  or: "enshrd_query -s <server> -p <port>"
  *** Server infos can be set in script variable to avoid input

Modes:
  [default] No Argument                  # Query All Steam Server Infos
  -u|--user                              # Query currently connected user(s)
  -n|--number                            # Output only the number [0-9] of connected users (used locally for server restart/update)
  -l|--local                             # Used for server-side local run
  -f|--full                              # Output all 'a2s' informations available

Note

requires: python3 pip for SteamQuery lib install and use, ssh access to the server (preferably with a running agent), python3 -m pip install python-a2s


screenshot:



enshrd_steamuser_check

  • Monitor enshroudedserver.log for [successfull/failed] connection attempts
  • Convert Steam ID to Steam Username (uses 'Steam Api' if _APIKEY='XXXXXX' is provided or 'https://steamid.io')
  • Keep a fresh list of currently logged in Users
  • Optional [_TELEGRAM_ALERT="true"] - send custom message to telegram channel on User Login/Logout

Tip

Crontab every minute :

*/1 * * * * /usr/local/sbin/enshrd_steamuser_check

telegram-alert sample script can be found here :

https://raw.githubusercontent.com/zephxs/ncat-ipset-honeypot/master/telegram-send

Sample logs:

$cat ~/enshrd-monitor/user-connection.log
[2024-04-15 10:31:30] [INFO] New ID(s) detected = 0(1)
[2024-04-15 10:31:36] [INFO] User Connected = Ares 0(1)
[2024-04-15 11:57:34] [INFO] User Logout = Ares


enshrd_backupgrade

  • Auto backup Map files (server 'savegame' folder)
  • Auto Update Game Server Files with SteamCMD if Steam Game Repository have a new update
  • Optional [_PROTON_UPDATE="true"] - Auto Update Proton binary with proton-update script

Note

requires: enshrd_query to block process if users are connected to the instance

Tip

Crontab every day for ex. @4:30 AM :

30 4 * * * /usr/local/sbin/enshrd_backupgrade

Sample logs:

$cat ~/enshrd-monitor/update.log
[2024-06-07 04:05:33] [START] Enshrouded server Backup / Update started
[2024-06-07 04:05:33] [INFO] Current version: 532860
[2024-06-07 04:05:34] [INFO] Active User(s) detected: '0'
[2024-06-07 04:05:34] [INFO] Stopping service: enshrd.service
[2024-06-07 04:07:09] [INFO] Backup Map files: /home/enshrouded/enshrd-bak/Enshrouded_Map-07062024-0407.zip
[2024-06-07 04:07:10] [INFO] Steam Core Game Repo last update: Thu Jun  6 11:17:37 UTC 2024
[2024-06-07 04:07:10] [INFO] Starting SteamCMD Game Update
[2024-06-07 04:07:10] [INFO] SteamCMD Log: /home/enshrouded/enshrd-monitor/steamcmd-last-update.log
[2024-06-07 04:08:52] [SUCCESS] SteamCMD Update Success!
[2024-06-07 04:08:53] [INFO] Proton Current Version: GE-Proton9-6
[2024-06-07 04:08:53] [INFO] Upgrading to Proton Latest: GE-Proton9-7
[2024-06-07 04:09:02] [INFO] GE-Proton9-7 Execution tests Validated! Installing..
[2024-06-07 04:09:02] [SUCCESS] GE-Proton9-7 Install Complete!
[2024-06-07 04:09:02] [INFO] Restarting service: enshrd.service
[2024-06-07 04:10:08] [END_SUCCESS] Enshrouded Server [Version:533348] - Backup/Update Complete!


proton-update [Option in enshrd_backupgrade]

  • Transparently Update Proton Installation if new latest version is availaible on Github "GloriousEggroll" Repository (cf. https://github.com/GloriousEggroll/proton-ge-custom/releases)
  • Defined Proton install directory: <Enshrouded User Homedir>/.steam/root/compatibilitytools.d/Proton-latest
  • Automatic Symlink / test new Proton and its embedded wine64 binaries before installing
ls -lah $HOME/.steam/root/compatibilitytools.d/

drwxr-xr-x 4 enshrouded enshrouded 4.0K Apr 15 18:58 GE-Proton9-3
drwxr-xr-x 4 enshrouded enshrouded 4.0K Apr 18 11:30 GE-Proton9-4
lrwxrwxrwx 1 enshrouded enshrouded   58 Apr 18 11:30 Proton-latest -> /home/enshrouded/.steam/root/compatibilitytools.d/GE-Proton9-4


enshrd-api

  • Flask API Endpoint : serve enshrd_query informations on port "8080"
  • "Password" will be the same as the Enshrouded Game Server (adapt enshrouded_server.json location in app.py)
  • "User" does not matter (can be empty)

Note

requires: enshrd_query and 2squery.py in user PATH Setup : Copy enshrd-api folder to Home Folder of the Enshrouded User cd $HOME/enshrd-api; python3 -m venv venv python3 -m pip install python-a2s Flask Flask-HTTPAuth gunicorn

Sample Flask Service using "Gunicorn" with 2 workers (port can be modified here) : /etc/systemd/system/enshrd-api.service

[Unit]
Description=Gunicorn instance to serve enshrd_query
After=network.target

[Service]
User=enshrouded
WorkingDirectory=/home/enshrouded/enshrd-api
Environment="PATH=/home/enshrouded/enshrd-api/venv/bin:/usr/bin:/usr/local/bin"
ExecStart=/home/enshrouded/enshrd-api/venv/bin/gunicorn --workers 2 --bind 0.0.0.0:8080 app:app

[Install]
WantedBy=multi-user.target


Server Config for educational purpose :


Sample Proton Service: /etc/systemd/system/enshrd.service

cat /etc/systemd/system/enshrd.service
[Unit]
Description=Enshrouded Server
Wants=network-online.target
After=network-online.target
[Service]
User=enshrouded
Group=enshrouded
Environment="STEAM_COMPAT_CLIENT_INSTALL_PATH=/home/enshrouded/Steam"
Environment="STEAM_COMPAT_DATA_PATH=/home/enshrouded/Steam/steamapps/compatdata"
WorkingDirectory=/home/enshrouded/enshroudedserver/
ExecStart=/home/enshrouded/.steam/root/compatibilitytools.d/Proton-latest/proton run enshrouded_server.exe
Restart=always
[Install]
WantedBy=multi-user.target

Sample Wine Service: /etc/systemd/system/enshrd.service

[Unit]
Description=Enshrouded Server
Wants=network-online.target
After=network-online.target
[Service]
User=enshrouded
Group=enshrouded
WorkingDirectory=/home/enshrouded/
ExecStart=/usr/local/bin/wine64 /home/enshrouded/enshroudedserver/enshrouded_server.exe
Restart=always
[Install]
WantedBy=multi-user.target

Sample Sudoer file: visudo /etc/sudoers.d/enshrouded-user

enshrouded ALL=(ALL) NOPASSWD:/usr/bin/systemctl start enshrd.service,/usr/bin/systemctl stop enshrd.service,/usr/bin/systemctl restart enshrd.service,/usr/bin/systemctl is-active enshrd.service