RustMinerSystem

Documentation

RMS On-Site Mining Access Client Documentation

Learn where RMS fits in RustMinerSystem and how RMS3(NB), encrypted compression, connection consolidation, deployment, and rollout work.

RMS Documentation

RMS is an optional on-site access client deployed inside a mining-farm LAN. Miners connect to a local RMS listener; RMS then reaches the remote RustMinerSystem server over a protected RMS protocol link to reduce public-network traffic, consolidate outbound connections, and expose on-site runtime monitoring.

RMS does not replace the RustMinerSystem server. Small sites with stable networking and sufficient bandwidth can connect miners directly to RustMinerSystem without deploying RMS.

Where RMS Fits

Miners / ASICs
    │ Local Stratum
    ▼
RMS on-site client
    │ RMS2 / RMS3 / RMS3(Zstd) / RMS3(NB)
    │ Encryption, compression, connection consolidation
    ▼
RustMinerSystem server
    │ Proxy, wallet policy, statistics, and security
    ▼
Third-party pool or PoolNode

RustMinerSystem owns proxy ports, upstream pools, wallet and fee policy, statistics, security, and PoolNode expansion. RMS owns only on-site access, transport optimization, and local observability. See the RustMinerSystem documentation for server features and the PoolNode documentation for real-pool operation.

Core Capabilities

Capability What RMS does
Public traffic compression Uses RMS3, RMS3(Zstd), or RMS3(NB) to reduce traffic between the site and server.
Connection consolidation Multiplexes many miner sessions into fewer public outbound connections.
Protected transport Protects the RMS-to-RustMinerSystem protocol link.
Automatic or manual setup Synchronizes ports through a push URL or accepts manually entered server targets.
Multiple remote targets Distributes connections across compatible server addresses for one local port.
On-site monitoring Shows inbound/outbound connections, CPU, memory, network, and port status.
Backend protection Supports an access password and a custom safe access path.

Choose a Protocol

Protocol Recommended use Main constraint
RMS3(NB) Large BTC/LTC sites and extreme traffic reduction BTC and LTC only; up to 99.6% public traffic reduction under specific test conditions.
RMS3(Zstd) Balance compression with CPU use Uses RMS3 connection behavior and is typically more CPU-friendly.
RMS3 General high-compression deployments Higher compression normally increases CPU pressure.
RMS2 Compatible historical RMS2 server ports Compatibility only; RMS3 is not backward-compatible with RMS2.

The local RMS and server port must use the same coin, protocol, password, and applicable compression settings. RMS2, RMS3, RMS3(Zstd), and RMS3(NB) are not interchangeable. Read RMS3(NB) before deploying NB.

Documentation Map

Page What it covers
Installation Install Linux, OpenWrt, or Windows builds and make a safe first connection.
Deployment and Pairing Prepare server ports and pair through a push URL or manual setup.
Port Mapping Create local listeners and configure remote targets, passwords, and load distribution.
Compression Select a protocol, compression level, and outbound connection count.
RMS3(NB) Deploy the BTC/LTC extreme-compression link and interpret the 99.6% claim correctly.
Monitoring and Operations Monitor connections and resources, maintain the service, and protect backend access.
Troubleshooting Locate mismatches, connectivity failures, rejection changes, and rollback paths.

Shortest Safe Rollout

  1. Create the matching RMS protocol port in RustMinerSystem.
  2. Install RMS at the site and assign the device a fixed LAN IP.
  3. Synchronize a push configuration or create a manual local mapping.
  4. Point a few miners to stratum+tcp://RMS_LAN_IP:LOCAL_PORT.
  5. Verify inbound/outbound connections, server hashrate, upstream rejects, and CPU before expanding in batches.

Before Production

  • Keep a bypass address that connects miners directly to RustMinerSystem.
  • Record the RMS version, mappings, protocols, and compression settings.
  • Back up the RustMinerSystem port configuration.
  • Never expose the RMS management port directly to the public Internet.
  • Set a backend password and restrict access to trusted LAN sources.

Compression depends on the coin, miner protocol, connection count, parameters, CPU, and network quality. Treat published ratios as results from specific tests and validate your own site with a small pilot.

Resources