Rust Autowipe

Games
Report Issue

The only aim in Rust is to survive. To do this you will need to overcome struggles such as hunger, thirst and cold. Build a fire. Build a shelter. Kill animals for meat. Protect yourself from other players, and kill them for meat. Create alliances with other players and form a town. Do whatever it takes to survive.

Contributors:
danielb@purpleflaghosting.com
README

Rust Autowipe

The only aim in Rust is to survive. To do this you will need to overcome struggles such as hunger, thirst and cold. Build a fire. Build a shelter. Kill animals for meat. Protect yourself from other players, and kill them for meat. Create alliances with other players and form a town. Do whatever it takes to survive.

Adds variables to wipe files based on a list you set. Reinstall to perform the wipe.

The variable REGEN_SERVER was added, default 0, set to 1 to generate a random seed and remove old files on reinstall.

Files listed in the REMOVE_FILES variable, space separated, will be removed.

Minimum RAM warning

The server requires at least 4096MB to run properly. This is mostly needed for the startup only, once it is running (depending on your world size) it should consume less.

Server Ports

Ports required to run the server.

Port default
Game and Query 28015 UDP
RCON 28016 TCP

Information about server updates can be found here

Docker Images (1)
Name Image
ghcr.io/pterodactyl/games:rust ghcr.io/pterodactyl/games:rust
Startup Command 
"./RustDedicated -batchmode +server.port {{SERVER_PORT}} +server.queryport {{QUERY_PORT}} +server.identity "rust" +rcon.ip 0.0.0.0 +rcon.port {{RCON_PORT}} +rcon.web true +server.hostname \"{{HOSTNAME}}\" +server.level \"{{LEVEL}}\" +server.description \"{{DESCRIPTION}}\" +server.url \"{{SERVER_URL}}\" +server.headerimage \"{{SERVER_IMG}}\" +server.maxplayers {{MAX_PLAYERS}} +rcon.password \"{{RCON_PASS}}\" +app.port {{APP_PORT}} +server.saveinterval {{SAVEINTERVAL}} $( [ -z ${MAP_URL} ] && printf %s "+server.worldsize \"{{WORLD_SIZE}}\" +server.seed \"$( if [ -f seed.txt ] && [[ ${WORLD_SEED} == "0" ]]; then printf %s $(cat seed.txt); else printf %s ${WORLD_SEED}; fi )\""|| printf %s "+server.levelurl {{MAP_URL}}" ) {{ADDITIONAL_ARGS}}"
Variables (19)

SRCDS_APPID

Environment:
SRCDS_APPID
Default:
258550
User Viewable:
❌
User Editable:
❌
Rules:
required|string|max:20

Max Players

The maximum amount of players allowed in the server at once.

Environment:
MAX_PLAYERS
Default:
40
User Viewable:
❌
User Editable:
❌
Rules:
required|integer

Server Name

The name of your server in the public server list.

Environment:
HOSTNAME
Default:
A Rust Server
User Viewable:
❌
User Editable:
❌
Rules:
required|string|max:40

Level

The world file for Rust to use.

Environment:
LEVEL
Default:
Procedural Map
User Viewable:
❌
User Editable:
❌
Rules:
required|string|max:20

Description

The description under your server title. Commonly used for rules & info. Use \n for newlines.

Environment:
DESCRIPTION
Default:
Powered by Pterodactyl
User Viewable:
❌
User Editable:
❌
Rules:
required|string

URL

The URL for your server. This is what comes up when clicking the "Visit Website" button.

Environment:
SERVER_URL
Default:
http://pterodactyl.io
User Viewable:
❌
User Editable:
❌
Rules:
nullable|url

World Size

The world size for a procedural map.

Environment:
WORLD_SIZE
Default:
3000
User Viewable:
❌
User Editable:
❌
Rules:
required|integer

World Seed

The seed for a procedural map.

Environment:
WORLD_SEED
Default:
0
User Viewable:
❌
User Editable:
❌
Rules:
nullable|string

Server Image

The header image for the top of your server listing.

Environment:
SERVER_IMG
Default:
None
User Viewable:
❌
User Editable:
❌
Rules:
nullable|url

RCON Port

Port for RCON connections.

Environment:
RCON_PORT
Default:
28016
User Viewable:
❌
User Editable:
❌
Rules:
required|integer

RCON Password

RCON access password.

Environment:
RCON_PASS
Default:
CHANGEME
User Viewable:
❌
User Editable:
❌
Rules:
required|regex:/^[\w.-]*$/|max:64

Save Interval

Sets the server’s auto-save interval in seconds.

Environment:
SAVEINTERVAL
Default:
60
User Viewable:
❌
User Editable:
❌
Rules:
required|integer

Additional Arguments

Add additional startup parameters to the server.

Environment:
ADDITIONAL_ARGS
Default:
None
User Viewable:
❌
User Editable:
❌
Rules:
nullable|string

Regen Server

If the server should have its files removed and regenerate the server seed on reinstall.

Environment:
REGEN_SERVER
Default:
0
User Viewable:
❌
User Editable:
❌
Rules:
required|boolean

Files to remove

A space-separated list of files to remove when regenerating the server on reinstall.

Environment:
REMOVE_FILES
Default:
server/rust/player.deaths.*.db server/rust/player.identities.*.db server/rust/player.states.*.db server/rust/player.tokens.db proceduralmap.*.*.*.map server/rust/proceduralmap.*.*.*.sav oxide/data/Kits_Data.json oxide/data/NTeleportationHome.json oxide/data/ServerRewards/player_data.json oxide/data/PTTracker/playtime_data.json
User Viewable:
❌
User Editable:
❌
Rules:
required|string

QUERY PORT

Port for QUERY connections.

Environment:
QUERY_PORT
Default:
28017
User Viewable:
❌
User Editable:
❌
Rules:
required|integer

APP PORT

Port for Rust+ applications. -1 to disable.

Environment:
APP_PORT
Default:
28082
User Viewable:
❌
User Editable:
❌
Rules:
required|integer

Custom Map URL

Overwrites the map with the one from the direct download URL. Invalid URLs will cause the server to crash.

Environment:
MAP_URL
Default:
None
User Viewable:
❌
User Editable:
❌
Rules:
nullable|url

Modding Framework

The modding framework to be used: carbon, oxide, vanilla. Defaults to "vanilla" for a non-modded server installation.

Environment:
FRAMEWORK
Default:
vanilla
User Viewable:
❌
User Editable:
❌
Rules:
required|string|in:vanilla,carbon,oxide
Installation Script
Container: ghcr.io/ptero-eggs/installers:debian
Entrypoint: bash
#!/bin/bash
# steamcmd Base Installation Script
#
# Server Files: /mnt/server
# Image to install with is 'ghcr.io/ptero-eggs/installers:debian'

##
#
# Variables
# STEAM_USER, STEAM_PASS, STEAM_AUTH - Steam user setup. If a user has 2fa enabled it will most likely fail due to timeout. Leave blank for anon install.
# WINDOWS_INSTALL - if it's a windows server you want to install set to 1
# SRCDS_APPID - steam app id found here - https://developer.valvesoftware.com/wiki/Dedicated_Servers_List
# SRCDS_BETAID - beta branch of a steam app. Leave blank to install normal branch
# SRCDS_BETAPASS - password for a beta branch should one be required during private or closed testing phases.. Leave blank for no password.
# INSTALL_FLAGS - Any additional SteamCMD  flags to pass during install.. Keep in mind that steamcmd auto update process in the docker image might overwrite or ignore these when it performs update on server boot.
# AUTO_UPDATE - Adding this variable to the egg allows disabling or enabling automated updates on boot. Boolean value. 0 to disable and 1 to enable.
#
 ##

# Install packages. Default packages below are not required if using our existing install image thus speeding up the install process.
#apt -y update
#apt -y --no-install-recommends install curl lib32gcc-s1 ca-certificates

## just in case someone removed the defaults.
if [[ "${STEAM_USER}" == "" ]] || [[ "${STEAM_PASS}" == "" ]]; then
    echo -e "steam user is not set.\n"
    echo -e "Using anonymous user.\n"
    STEAM_USER=anonymous
    STEAM_PASS=""
    STEAM_AUTH=""
else
    echo -e "user set to ${STEAM_USER}"
fi

## download and install steamcmd
cd /tmp
mkdir -p /mnt/server/steamcmd
curl -sSL -o steamcmd.tar.gz https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz
tar -xzvf steamcmd.tar.gz -C /mnt/server/steamcmd
mkdir -p /mnt/server/steamapps # Fix steamcmd disk write error when this folder is missing
cd /mnt/server/steamcmd

# SteamCMD fails otherwise for some reason, even running as root.
# This is changed at the end of the install process anyways.
chown -R root:root /mnt
export HOME=/mnt/server

## install game using steamcmd
./steamcmd.sh +force_install_dir /mnt/server +login ${STEAM_USER} ${STEAM_PASS} ${STEAM_AUTH} $( [[ "${WINDOWS_INSTALL}" == "1" ]] && printf %s '+@sSteamCmdForcePlatformType windows' ) +app_update ${SRCDS_APPID} $( [[ -z ${SRCDS_BETAID} ]] || printf %s "-beta ${SRCDS_BETAID}" ) $( [[ -z ${SRCDS_BETAPASS} ]] || printf %s "-betapassword ${SRCDS_BETAPASS}" ) ${INSTALL_FLAGS} validate +quit ## other flags may be needed depending on install. looking at you cs 1.6

## set up 32 bit libraries
mkdir -p /mnt/server/.steam/sdk32
cp -v linux32/steamclient.so ../.steam/sdk32/steamclient.so

## set up 64 bit libraries
mkdir -p /mnt/server/.steam/sdk64
cp -v linux64/steamclient.so ../.steam/sdk64/steamclient.so

## add below your custom commands if needed


if [ ${REGEN_SERVER} == "1" ]; then
    cd /mnt/server/
    rm -rf ${REMOVE_FILES}
fi

if [ $WORLD_SEED == "0" ]; then
    if [ ! -f /mnt/server/seed.txt ]; then
        rm -sf /mnt/server/seed.txt
    fi
    
    cat /dev/urandom | tr -dc '1-9' | fold -w 5 | head -n 1 > /mnt/server/seed.txt
fi

## install end
echo "-----------------------------------------"
echo "Installation completed..."
echo "-----------------------------------------"