Build, run, and scale your SSM Nexus ecosystem.

Install the SSM Nexus client

1. Download SSMNexus.exe from the updates host.
2. Run the installer and keep default path unless you use custom storage drives.
3. Launch the client and sign in to your portal account.

Download URL
https://updates.ssmnexus.org/SSMNexus.exe

Choose your game source

During first launch, select where you own the game: Steam, Epic, or Rockstar. The launcher stores this preference and uses it for stable startup.

• Steam path can be auto-detected or set manually.
• Epic and Rockstar installs can be mapped from launcher settings.
• If the executable is missing, launcher can trigger the bootstrap installer URL.

Join servers fast

Use join codes or discover from the portal list. Favorites are saved locally and can be pinned for one-click reconnect.

Join flow
Portal -> /v1/servers -> /v1/join/{id} -> Launcher token handoff

Register server keys

Use the Portal "Server Registration Keys" panel to create and rotate access keys.

• Label keys by environment: staging, production, event servers.
• Set key ownership at team level so your ops staff can rotate safely.
• Revoke keys immediately if a host or contractor leaves the project.

Runtime artifacts (Windows and Linux)

Keep runtime packages current so launcher and server compatibility stay aligned.

Windows script
SSM-LAUNCHER/tools/update-runtime-artifacts.ps1

Linux script
SSM-LAUNCHER/tools/update-runtime-artifacts.sh

Pterodactyl support

Use the included egg file to run SSM Nexus servers on Pterodactyl with your own startup variables and update channels.

Egg file
SSM-LAUNCHER/pterodactyl/egg-ssm-network-linux.json

Core API endpoints

Base URL
https://api.ssmnexus.org/v1

Example endpoints
GET  /servers
GET  /join/{id}
POST /auth/register
POST /auth/login
GET  /subscriptions/club
POST /eup/slots/grants/manual

Discord OAuth login

Portal users can sign in with Discord using the account card. Configure Discord client values in API environment and keep callback domain locked to your production host.

• One account identity for portal, launcher, and marketplace actions.
• Supports automatic account creation on first Discord sign-in.
• Use team role checks before allowing creator publishing actions.

OpenIV and custom assets

SSM Nexus supports custom EUP and addon workflows through grants and slot entitlements. Keep asset metadata and entitlement logs in sync for reliable client access control.

Tebex purchase sync

Connect Tebex webhooks so purchases grant portal entitlements automatically after payment.

• Map product IDs to SSM subscription plans or asset grants.
• Log webhook deliveries with status and retry metadata.
• Show final entitlement state in the user account dashboard.

Nexus Club plans

Plan tiers include slots, upvotes, custom clothing streaming support, and listing highlights. You can also issue manual help grants for communities in financial hardship.

Domain and proxy routing

Recommended host map:

ssmnexus.org            -> /srv/site
docs.ssmnexus.org       -> /srv/docs
portal.ssmnexus.org     -> /srv/portal
api.ssmnexus.org        -> platform-api:8080
updates.ssmnexus.org    -> /srv/updates
status.ssmnexus.org     -> /srv/portal/status + /v1 + /updates

Smoke test checklist

Run your production smoke test after each deployment to verify DNS, portal, API, updates, bootstrap installer, and docs availability.

Script
SSM-DOMAIN/scripts/run-smoke-test.ps1

Rollback strategy

• Keep previous launcher/runtime zip packages for one-click package rollback.
• Tag API releases with schema versions from OpenAPI.
• Roll back Caddyfile and static folders independently from API images.