Egg Repository

Pterodactyl Community Egg Repository

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.

Read Me

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

Yolks
NameTag
ghcr.io/pterodactyl/games:rustghcr.io/pterodactyl/games:rust
Variables
NameDescriptionEnvironment VariableDefault ValueUser ViewableUser Editable
SRCDS_APPIDSRCDS_APPID258550NoNo
Max PlayersThe maximum amount of players allowed in the server at once.MAX_PLAYERS40YesYes
Server NameThe name of your server in the public server list.HOSTNAMEA Rust ServerYesYes
LevelThe world file for Rust to use.LEVELProcedural MapYesYes
DescriptionThe description under your server title. Commonly used for rules & info. Use \n for newlines.DESCRIPTIONPowered by PterodactylYesYes
URLThe URL for your server. This is what comes up when clicking the "Visit Website" button.SERVER_URLhttp://pterodactyl.ioYesYes
World SizeThe world size for a procedural map.WORLD_SIZE3000YesYes
World SeedThe seed for a procedural map.WORLD_SEED0YesYes
Server ImageThe header image for the top of your server listing.SERVER_IMGYesYes
RCON PortPort for RCON connections.RCON_PORT28016YesNo
RCON PasswordRCON access password.RCON_PASSCHANGEMEYesYes
Save IntervalSets the server’s auto-save interval in seconds.SAVEINTERVAL60YesYes
Additional ArgumentsAdd additional startup parameters to the server.ADDITIONAL_ARGSYesYes
Regen ServerIf the server should have its files removed and regenerate the server seed on reinstall.REGEN_SERVER0YesYes
Files to removeA space-separated list of files to remove when regenerating the server on reinstall.REMOVE_FILESserver/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.jsonYesYes
QUERY PORTPort for QUERY connections.QUERY_PORT28017YesYes
APP PORTPort for Rust+ applications. -1 to disable.APP_PORT28082YesYes
Custom Map URLOverwrites the map with the one from the direct download URL. Invalid URLs will cause the server to crash.MAP_URLYesYes
Modding FrameworkThe modding framework to be used: carbon, oxide, vanilla. Defaults to "vanilla" for a non-modded server installation.FRAMEWORKvanillaYesYes
Install Script
#!/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 "-----------------------------------------"