DOCSEARCHbyAlgolia
Submit Docs

RustMinerSystem Documentation

website·Indexed 30 days ago

https://minerproxy.org

Comprehensive documentation for RustMinerSystem and PoolNode, covering installation, proxy port configuration, algorithm engine management, and security. Includes detailed API references for PoolNode project administration, worker statistics, and observer read-only access, as well as guides for the RustMinerSystem CLI and mobile app integration.

Tokens
46.6K
Snippets
138
Records
356
Agent score
49%

What's inside RustMinerSystem

  1. Overview of PoolNode capabilities

    PoolNode is a self-hosted module for the RustMinerSystem designed for operators who need a full pool infrastructure. Unlike a standard third-party pool proxy, PoolNode organizes the following around a CODE/TOKEN node group:

    • Public pool website and user registration
    • Worker and earnings queries
    • Per-coin node-fee configuration
    • Mining port management
    • Revenue settings and payout addresses
    • PoolNodeAPP and Open API access

  2. Overview of RustMinerSystem Custom Management

    Custom Management is the central operations console for managing RustMinerSystem custom builds. It allows operators to manage Client IDs (CIDs), client installations, active devices, coin permissions, inside fee configurations, audits, and account visibility. The console uses the CID as the primary management unit to track install scale, active devices, and specific service settings.

  3. Overview of RustMinerSystem Transparent Proxy

    Transparent proxy forwards incoming data to a configured target address without parsing the payload. Unlike plain forwarding (which typically targets a pool), transparent proxy is designed for use between RustMinerSystem nodes. It acts as a transparent jump path, meaning it does not identify miner protocols, wallets, or worker names, and does not apply fee logic or replacement rules. This avoids the need for the jump server to decrypt or decompress the RMS stream, reducing CPU cost and latency.

  4. Overview of RMS on-site access client

    RMS is an optional on-site access client deployed within a mining-farm LAN. It acts as a local listener for miners, consolidating outbound connections and compressing traffic before sending it to a remote RustMinerSystem server over a protected protocol link. This reduces public-network traffic and provides on-site runtime monitoring. RMS does not replace the RustMinerSystem server; small sites with stable networking may connect miners directly to the server instead.

  5. Overview of RustMinerSystem Core Server capabilities

    RustMinerSystem Core Server is used to prepare server programs for mining access, third-party pool proxying, and PoolNode deployments. It provides a unified access layer that supports hashrate allocation and proxying. The system allows routing by configuration to direct traffic to third-party pool proxies or real PoolNodes.

  6. Overview of the RustMinerSystem Custom iOS Widget

    The Custom iOS Widget is a home-screen companion for paid custom editions of RustMinerSystem. It provides a quick view of custom-edition summary statistics, including online devices, pending reviews, client count, coin device totals, hashrate, and trends. It is designed for monitoring and does not replace the full Custom Management console; configuration and audit tasks must still be performed in Custom Management.

  7. Overview of RustMinerSystem Server Core

    RustMinerSystem is a server management system for miners, mining sites, and pool operators. It provides tools for managing mining pool proxies, relays, and forwarding ports, as well as configuring upstream pools, wallets, worker names, and fee policies. It includes observability features to inspect hashrate, devices, latency, connections, and runtime logs, and can be extended into a self-owned pool using PoolNode settlement features.

  8. Overview of RMS3(NB) extreme-compression protocol

    RMS3(NB) is a specialized compression protocol for BTC and LTC mining-farm links designed to reduce public-network traffic (up to 99.6% in specific test conditions). It is intended for large sites, constrained uplinks, and expensive cross-region transport. It is strictly limited to BTC and LTC due to the specific traffic shapes of these coins; other coins should use RMS3 or RMS3(Zstd).

  9. Overview of RMS Secure Client

    RMS (RMS Secure Client) is a local client used for tunneling, data compression, encryption, and public connection compression. It facilitates a compressed encrypted link between a local site (including miner fleets, local networks, and access devices/routers) and a RustMiner host server, providing traffic compression, encrypted tunneling, and connection pooling.

  10. Overview of PoolNode Mobile App

    PoolNode Mobile App is the end-user mobile application designed for pool nodes built on the RustMinerSystem. It provides pool users with a mobile interface to monitor critical mining metrics, including earnings, hashrate trends, worker status, and asset records, mimicking a traditional mining-pool app experience.

  11. Overview of Wallet and Worker-Name Hot Replacement

    Wallet and worker-name hot replacement allows the server to dynamically rewrite the identity submitted by a miner while its proxy port is running. When a rule matches, the server forcibly disconnects the miner; the new wallet and worker name are applied upon the miner's next connection.

    This differs from 'Fee config hot update' in that it changes the connected miner's submitted identity and can optionally redirect the target pool, whereas fee updates only affect fee-related settings and do not disconnect miners.

  12. Use RustMinerSystem App for mobile operations monitoring

    RustMinerSystem App serves as a mobile operations console for RustMinerSystem. It allows users to monitor the following from a mobile device:

    • Pool proxy and PoolNode status
    • Server status and open ports
    • Wallet configurations
    • Worker hashrate data and device details

    The app is available for iOS via the App Store and for Android via direct APK download.