Configuration - SteamServerUI/StationeersServerUI GitHub Wiki

This document explains the various configuration options available for Stationeers Server UI. Configuration can be handled through three different methods, applied in the following order of precedence:

1. Environment variables (highest priority) - DISENCOURAGED, USE config.json
2. config.json file (middle priority)
3. Default values (lowest priority)

The server's user interface (UI) provides an intuitive way to adjust settings without directly editing the configuration file. To access it:

1. Launch the server application.
2. Locate and click the Config button on the main screen.
3. A configuration window will appear, allowing you to modify key server parameters.

For detailed explanations of each parameter, refer to the Configuration Reference section below. If you're unsure about a setting, the UI includes tooltips or descriptions for most fields.

For a typical multiplayer server, consider the following parameters:

• ServerName: Set your server's name
• Save Info: Your Save Name, optionally with a World name to generate
• ServerPassword: Set a password if you want a private server
• ServerMaxPlayers: Set the maximum number of concurrent players
• AutoSave: Enable automatic saving
• SaveInterval: Set the interval between automatic saves, e.g. 300 seconds

All configuration options can now be set using environment variables. This is particularly useful for containerized deployments or when you want to override configuration without modifying the config.json file.

Environment variable names are uppercase with underscores separating words, corresponding to their JSON counterparts. For example:

• discordToken in JSON becomes DISCORD_TOKEN as an environment variable
• ServerMaxPlayers in JSON becomes SERVER_MAX_PLAYERS as an environment variable

The config.json file stores all settings in JSON format and is located at ./UIMod/config/config.json. Changes to this file will be applied upon server restart.

If a configuration value is not specified in either environment variables or the config.json file, a default value will be used.

The following table provides a detailed breakdown of all available configuration options:

This list is slightly outdated, sorry about that

• LogLevel: Sets the logging severity level:

  • 10: Debug
  • 20: Info (Default)
  • 30: Warn
  • 40: Error

• CreateSSUILogFile: When enabled, logs operations to ./UIMod/logs/. Default: false.

• SubsystemFilters: Array of subsystem names to filter logs, allowing you to focus on specific parts of the application.

Note: Gameserver logs are only saved to a file on Linux systems, where debug.log is written by the gameserver and are not included in the SSUI log files.

• Users: Map of usernames to hashed passwords for UI authentication.
• AuthEnabled: When true, requires authentication to access the UI.
• JwtKey: Secret key used for JWT token generation.
• AuthTokenLifetime: Duration in minutes that authentication tokens remain valid.

• BackupKeepLastN: Specifies the number of most recent backups to keep (default: 2000).
• IsCleanupEnabled: When true, enables automatic cleanup of the Backups and Safebackups folders. Default: false.
• BackupKeepDailyFor: Retention period in hours for daily backups.
• BackupKeepWeeklyFor: Retention period in hours for weekly backups.
• BackupKeepMonthlyFor: Retention period in hours for monthly backups.
• BackupCleanupInterval: Hours between backup cleanup operations.
• BackupWaitTime: Seconds to wait before copying backup groups to the Safebackups folder.

The backup system, as of April 20, 2025, deletes files in the safe backup directory based on a retention policy that (for example) keeps the two most recent backup groups, one backup per day for 7 days, one per week for 4 weeks, and one per month for 3 months. Files not meeting these criteria are removed to save disk space. The example below shows which backup groups are kept or deleted during a cleanup run on April 20, 2025, at 12:00 PM UTC.

• IsUpdateEnabled: When true, automatically checks for and downloads new executable updates from GitHub. Default: true.
• AllowPrereleaseUpdates: When true, includes prerelease versions in update checks. Default: false.
• AllowMajorUpdates: When true, allows installation of major version updates that might include breaking changes. Default: false.

The SaveInfo parameter has a special format that affects how the world is generated:

• Single word (e.g., "Moon"): Uses only the save name
• Two words (e.g., "Moon Moon"): First word is the save name, second is the world type

When this parameter is processed, the system automatically sets:

• WorldName: The first part of SaveInfo
• BackupWorldName: The second part of SaveInfo (if provided)

{
  "discordToken": "",
  "controlChannelID": "",
  "statusChannelID": "",
  "connectionListChannelID": "",
  "logChannelID": "",
  "saveChannelID": "",
  "controlPanelChannelID": "",
  "DiscordCharBufferSize": 1000,
  "blackListFilePath": "./Blacklist.txt",
  "isDiscordEnabled": false,
  "errorChannelID": "",
  "backupKeepLastN": 2000,
  "isCleanupEnabled": true,
  "backupKeepDailyFor": 24,
  "backupKeepWeeklyFor": 168,
  "backupKeepMonthlyFor": 730,
  "backupCleanupInterval": 730,
  "backupWaitTime": 30,
  "gameBranch": "public",
  "ServerName": "StationeersServerWithUI",
  "SaveInfo": "Moon Moon",
  "ServerMaxPlayers": "8",
  "ServerPassword": "secret",
  "ServerAuthSecret": "",
  "AdminPassword": "",
  "GamePort": "27016",
  "UpdatePort": "27015",
  "UPNPEnabled": false,
  "AutoSave": true,
  "SaveInterval": "300",
  "AutoPauseServer": true,
  "LocalIpAddress": "0.0.0.0",
  "StartLocalHost": false,
  "ServerVisible": true,
  "UseSteamP2P": true,
  "ExePath": "",
  "AdditionalParams": "",
  "users": null,
  "authEnabled": false,
  "JwtKey": "",
  "AuthTokenLifetime": 1440,
  "Debug": false,
  "CreateSSUILogFile": true,
  "LogLevel": 20,
  "subsystemFilters": [],
  "isUpdateEnabled": true,
  "allowPrereleaseUpdates": false,
  "allowMajorUpdates": false
}

# Discord Configuration
export DISCORD_TOKEN="your_discord_token"
export IS_DISCORD_ENABLED=true
export CONTROL_CHANNEL_ID="123456789012345678"

# Game Settings
export SERVER_NAME="My Stationeers Server"
export SAVE_INFO="Mars Mars"
export SERVER_MAX_PLAYERS="10"
export SERVER_PASSWORD="mysecretpassword"

# Backup Configuration
export BACKUP_KEEP_LAST_N=500
export IS_CLEANUP_ENABLED=true

# UI Authentication
export SSUI_AUTH_ENABLED=true
export SSUI_USERS="admin:hashedpassword123,moderator:hashedpassword456"
export SSUI_JWT_KEY="your-secure-jwt-key"

# Update Settings
export IS_UPDATE_ENABLED=true
export ALLOW_PRERELEASE_UPDATES=false

# Logging
export LOG_LEVEL=10
export CREATE_SSUI_LOGFILE=true
export SUBSYSTEM_FILTERS="gameserver,backup,discord"

When the server starts, it follows this process to determine the final configuration:

removed, use config.json

You can also customize your gameserver even further by adding parameters in the Additional Parameters field, both from the Json or the UI. These parameters allow you to control even more aspects of the game, from weird graphics stuff to experimental unity server configuration.