Basic Configuration

Configuring the CryptoNote Switching Relay Proxy

---

Starting

1. Clone this repository from Proxy Github Page.
2. Install node.js.
3. In the repository directory, rename config.json_commented or config.json_example to config.json.
4. Using a text editor, or perhaps an online json editor edit the config as needed.
   • The linked online editor also allows you to fix common json mistakes which causes failure to start the proxy.
   • You can also reformat the json for easy reading.
   • The comments describe each property in detail, pay attention!

Config.json Basics

Structure of a "user"

Users defined in the config.json under pools object contain information on coins to mine. Typically, you can group same algo coins under a user. Multiple worker machines can connect to a single user. Here's an example user, containing two same algo coins which can be switched to on the fly:

"UserBittube": [
   {
      "symbol":"BitTubeOfficial",
      "name":"bxdyourbittubeaddressd32bE5qaYQy.195000",
      "host":"mining.bit.tube",
      "port":"17777",
      "url":"https://mining.bit.tube/",
      "api":"https://mining.bit.tube/api/",
      "ticker": {
           "marketname": "btc-tube"
      }
   },
   {
      "symbol":"IPBCrocks",
      "name":"bxdpyouripbcaddressAdWxpaKzoftoeJHpd32bE5qaYQy.195000",
      "host":"ipbcrocks.ingest.cryptoknight.cc",
      "port":"5633",
      "url":"https://cryptoknight.cc/ipbcrocks/",
      "api":"https://cryptoknight.cc/rpc/ipbr"
    }
]

Property	Description
UserBittube	This is an example username, which the miner's will use in the 'wallet'/'user' pool config. So in your miner, instead of wallet, you'll enter the name you declared here.
symbol	Coin's name that will be shown in UI
name	Username for your pool, most of the time this your wallet address, which may also contain syntax to request static difficulty / declare a login name for pool side setup etc. etc.
host	mining pool's address (Do not add the port number here)
port	mining pool's port number
url	mining pool's default dashboard url
api	(Optional) Your pool's mining api. If you do not know the api of the pool you are mining, you can use a known api, but it's best that you work using the same api pool is providing. Required for profit based coin switching.
ticker	(Optional) Property that stores ticker related information
ticker.marketname	ticker name of the coin (currently only TrageOgre is supported)
ticker.convertobtc	ticker name to convert the coin value to btc, only requried if marketname ticker is not a btc market!

Miner Basics

The proxy may run on the mining computer or any other computer that your miners can connect to. You have to point the proxy as if it is a normal pool, with the miner port you have defined in the config file.

Tip: You can still use backup pools in your miner's pool settings in case there's a problem with the proxy.

Tip: If you have defined a static difficulty in proxy configuration, you can override that difficulty setting by adding it at the end of the username with a . or + in the middle.

Example SRBMiner pools.txt to connect to the UserBittube user in the proxy:

{
    "pools" :
    [
    	{"pool" : "127.0.0.1:2349", "wallet" : "UserBittube", "password" : "MyVegaRig"}
    ]
}

Example Pools array in XMRig miner config to connect to the UserBittube user with a custom difficulty override.

    "pools": [
        {
            "url": "127.0.0.1:2349", "user": "UserBittube+5000", "pass": "MyCPUrig",
            "rig-id": null, "nicehash": false, "keepalive": false
        }
    ],

Further Questions

Support: hesido@yahoo.com

Contact me at the support mail or at hesido.com contact page if you want to sponsor a feature.