Skip to content

Releases: Knaledge/openstarbound-server

Hotfix 1.1.1a: Add range validation to 'BACKUP_MAX_COUNT'

Choose a tag to compare

@Knaledge Knaledge released this 15 May 00:20

openstarbound-server 1.1.1a


Hotfixes

  • Added range of 1 - 365 (i.e. expect a min value of non-negative non-zero, and again to ensure a sane upper boundary for retention)

Documentation

  • Updated README.md to reflect BACKUP_MAX_COUNT validation

Docker Image

ghcr.io/knaledge/openstarbound-server:1.1.1a


Changelog Overview

Pull Requests

N/A

Full Changelog

Release 1.1.1: Script Cleanup & Better Validation

Choose a tag to compare

@Knaledge Knaledge released this 14 May 23:42
310e54f

openstarbound-server 1.1.1

This minor release delivers significant improvements to environment variable validation - include cron schedules. Additionally, every script now emits a clear log message and triggers each type of message (info, debug, error, etc.) consistently. Timezone-override support for the container is also now supported, ensuring log messages and cron schedules reflect the desired timezone.


Refactors & Improvements

  • Added support for the TZ environment variable, enabling container timezone override for logs and cron schedules (default is Etc/UTC) (see list of valid timezones at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
  • Introduced a dedicated bootstrap-validator script to isolate the environment variable validation component of game server bootstrap
  • Consolidated all environment variable validations to specific functions examining type (numeric, boolean, cron), range (if applicable), and format
  • Integrated cron expression validation (cron-validate.py using cron-validator by @kaka2507), ensuring only valid cron schedules are accepted when passed in via environment variable
  • Refactored the bootstrap process to use each new environment variable validator, replacing legacy validation
  • Standardized boolean environment variable handling across scripts by normalizing all 'true'/'false' values to lowercased comparisons for reliability
  • Improved error handling: container now stops cleanly during bootstrap process if any environment variable fails validation

Documentation

  • Expanded README.md to document all validated environment variables (e.g., their types, defaults, and validation rules - including explicit warnings about container termination on invalid input)
  • Added documentation for timezone support and cron schedule validation, with links to validation logic
  • Updated docker-compose.yml and comments to reflect new configuration options and validation requirements
  • Improved inline documentation and comments in scripts, especially in the new bootstrap-validator
  • Overhauled GitHub issue templates for bugs, features, and questions to be clearer and more user-friendly
  • Updated GitHub Actions workflows to standardize image naming, remove pinned versions, and improve Trivy scan coverage

Docker Image

ghcr.io/knaledge/openstarbound-server:1.1.1


Changelog Overview

Pull Requests

Full Changelog

Release 1.1.0: Steam Guard support

Choose a tag to compare

@Knaledge Knaledge released this 10 May 18:40
e4a34cd

openstarbound-server 1.1.0

This release features first-class support for Steam accounts that have Steam Guard enabled - allowing for MFA-protected authentication prior to game-server deployment while still making use of Docker-native secrets for Steam username/password credentials.


New Features

Steam Guard Support

  • Added STEAMGUARD_REQUIRED and STEAMGUARD_TIMEOUT environment variables to enable Steam Guard authentication and configure the timeout period for entering a Steam Guard code (README.md, docker-compose.yml, scripts/default/defaults)
  • Implemented the steamGuardAuth function in scripts/default/common to handle interactive Steam Guard authentication, including error handling for non-interactive shells and missing Docker secrets (scripts/default/common)
  • Integrated the steamGuardAuth function into the bootstrap script to ensure authentication is performed before starting the game server (scripts/default/bootstrap)

Refactors & Improvements

  • Updated the docker-compose.yml file to include tty: true and stdin_open: true for interactive Steam Guard sessions, and adjusted the restart policy to prevent infinite loops on authentication failure (docker-compose.yml)
  • Added a new volume for storing Steam Guard authentication data to persist credentials across container restarts (docker-compose.yml)

Documentation

  • Updated README.md to include instructions for enabling Steam Guard, configuring related environment variables, and troubleshooting authentication issues (README.md)
  • Modified the Docker Compose example in README.md to reflect the new volumes and interactive shell settings required for Steam Guard (README.md)

Docker Image:
ghcr.io/knaledge/openstarbound-server:1.1.0


Changelog Overview

Pull Requests

Full Changelog

Initial Release (1.0.0): Starbound + OpenStarbound (Linux server)

Choose a tag to compare

@Knaledge Knaledge released this 06 May 05:27
c7ed216

openstarbound-server 1.0.0

The first release of Docker-based Starbound server deployment stack - including optional deployment of the OpenStarbound Linux server.


New Features

  • Docker-native secrets support for Steam credentials & server RCON password
  • Integrated OpenStarbound download/install/update (including version tracking) via shared scripts
  • Revised backup system to handle Starbound save structure (including OpenStarbound context when enabled)

Refactors & Improvements

  • Reorganized & consolidated scripts: bootstrap, common, backup, updater, server
  • Overhauled environment-variable defaults (PUID/PGID, cron specs, log levels, ports)
  • Enhanced Supervisor profiles for deterministic Starbound → OpenStarbound startup
  • Improved server-launch arguments, config paths, version-file handling to better suit Starbound/OpenStarbound

Bug Fixes

  • Fixed cron-schedule quoting and crontab entry creation
  • Improved log message clarity, typo fixes, EOL normalization

Documentation

  • Fully revised and reorganized README.md
  • Clarified Docker Secrets usage, Compose examples, and environment variables
  • Added “Coming Soon” roadmap section

Thanks & Credits

The code and scripts in this project were iteratively built from enshrouded-server by @mornedhels, and inspired by plainsofpain-server by @traxo-xx.

Special thanks to the OpenStarbound Discord community for their support and feedback throughout technical development.


Docker Image:
ghcr.io/knaledge/openstarbound-server:1.0.0


Changelog Overview

Pull Requests

Full Changelog

https://github.com/Knaledge/openstarbound-server/commits/1.0.0

New Contributors