Quick Start Guide

🚀 StationeersServerUI Fast Track Start Guide

This guide provides the quickest way to get your Stationeers server up and running. Follow these straightforward steps for a minimal, working setup.

TL;DR FOR THE IMPATIENT

(like me) Download executable from GitHub, run it, login with admin/password at https://[your-ip]:8443, hit Start. Functioning Stationeers Server on Localhost.

📋 Quick Installation

Windows

1. Download the latest release from GitHub Releases
2. Place the executable in an empty folder of your choice
3. Run the executable. SSUI will download Steamcmd, Steamcmd will download Stationeers.
4. Access the WebUI at https://[your-server-ip]:8443

Linux

sudo apt-get update && sudo apt-get install -y lib32gcc-s1
# Download and make executable (replace X.X.X with version number)
wget https://github.com/jacksonthemaster/StationeersServerUI/releases/download/vX.X.X/StationeersServerControlX.X.X_release
chmod +x StationeersServerControlX.X.X_release
./StationeersServerControlX.X.X_release

# Access the WebUI at https://[your-server-ip]:8443

Docker

# Pull and run with Docker
docker run -d --name stationeers-ui -p 8443:8443 -p 27016:27016/tcp \
  -v ./config:/app/config -v ./saves:/app/saves \
  stationeers-server-ui:latest

🔑 Default Login

• Username: admin
• Password: password

⚙️ Minimal Configuration

1. Click the Config button in the WebUI
2. Set these essential parameters:
   • ServerName: Give your server a name
   • SaveInfo: Name your save (e.g., "MyBase Moon" for a new Moon world)
   • ServerMaxPlayers: Set number of players (e.g., "8")
   • LocalIpAddress: Your server's IP address (required for Linux)
   • ServerVisible: Set to true to appear in server list
   • AutoSave: Set to true for automatic saving
   • SaveInterval: "300" (5 minutes between saves)
3. Click Save to apply your settings

Important

For a working Server running on Linux, you need to configure LocalIpAddress correctly.

🚀 Start Your Server

1. Return to the dashboard by clicking Back
2. Click Start Server
3. Watch the console for startup progress
4. Connect via the Stationeers game client when ready

🔐 Security Quick Fix (Recommended)

Change the default credentials using one of these methods:

Option 1: Environment Variables (Recommended)

# Windows
set SSUI_USERNAME=your_username
set SSUI_PASSWORD=your_strong_password

# Linux
export SSUI_USERNAME=your_username
export SSUI_PASSWORD=your_strong_password

Option 2: Edit config.json

{
  "Username": "your_username",
  "Password": "your_strong_password"
}

🔌 Network Setup for External Players

1. Forward these ports on your router:

   • TCP 27016: Game port
   • TCP 27017: Update port
   • TCP 8443: WebUI (optional, only if remote admin needed)

2. Configure Windows Firewall:

   • Add inbound rules for ports 27016, 27017, and 8443

🚀 Advanced Features (Optional)

Enable these as needed:

Discord Integration

Backup Cleanup

Custom Detections

🛠️ Troubleshooting

• Server Won't Start: Check that save name is correctly capitalized with no spaces
• Can't Connect: Verify port forwarding and firewall settings
• WebUI Issues: Restart the executable completely

📚 Next Steps

For more detailed information:

• Full Configuration Guide
• Security Considerations
• Docker Guide