Skip to content

Operating HoloMUSH

Running HoloMUSH in production is straightforward. The server ships as a single binary with PostgreSQL as its only external dependency. Install it, point it at a database, and you're up.

Requirements

Component Minimum Recommended
CPU 1 core 2+ cores
Memory 256 MB 512 MB
PostgreSQL 18+ 18+
Storage 1 GB 10+ GB

Connection Methods

HoloMUSH supports two ways for players to connect:

  • Telnet (port 4201) -- Classic MU* client compatibility
  • WebSocket (port 8080) -- Modern web client with PWA support

Both protocols connect to the same game world and share the same session system. Run one or both depending on your player base.

Documentation

  • Installation -- Docker, binaries, or build from source
  • Deployment -- Production deployment with Docker Compose
  • Configuration -- Flags, config files, and environment variables
  • Database -- PostgreSQL setup, migrations, and maintenance
  • Authentication -- Security properties, rate limiting, and session management
  • Telnet Security -- Risks of cleartext telnet logins and how to mitigate them
  • CA Rotation -- When and how to rotate the internal mTLS certificate authority
  • Operations -- Health checks, metrics, monitoring, and troubleshooting
  • Verifying Releases -- Signature and provenance verification