Skip to content

Latest commit

 

History

History
103 lines (71 loc) · 4.43 KB

README.md

File metadata and controls

103 lines (71 loc) · 4.43 KB
Raw

xmr-node-proxy

Setup Instructions

Based on a clean Ubuntu 16.04 LTS minimal install

Switching from other xmr-node-proxy repository

cd xmr-node-proxy
git remote set-url origin https://github.com/MoneroOcean/xmr-node-proxy.git && git pull && npm update

Deployment via Installer

  1. Create a user 'nodeproxy' and assign a password (or add an SSH key. If you prefer that, you should already know how to do it)
useradd -d /home/nodeproxy -m -s /bin/bash nodeproxy
passwd nodeproxy
  1. Add your user to /etc/sudoers, this must be done so the script can sudo up and do it's job. We suggest passwordless sudo. Suggested line: <USER> ALL=(ALL) NOPASSWD:ALL. Our sample builds use: nodeproxy ALL=(ALL) NOPASSWD:ALL
echo "nodeproxy ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers
  1. Log in as the NON-ROOT USER you just created and run the deploy script. This is very important! This script will install the proxy to whatever user it's running under!
curl -L https://raw.githubusercontent.com/MoneroOcean/xmr-node-proxy/master/install.sh | bash
  1. Once it's complete, copy example_config.json to config.json and edit as desired.
  2. Run: source ~/.bashrc This will activate NVM and get things working for the following pm2 steps.
  3. Once you're happy with the settings, go ahead and start all the proxy daemon, commands follow.
cd ~/xmr-node-proxy/
pm2 start proxy.js --name=proxy --log-date-format="YYYY-MM-DD HH:mm Z"
pm2 save

You can check the status of your proxy by either issuing

pm2 logs proxy

or using the pm2 monitor

pm2 monit

Known Issues

VMs with 512Mb or less RAM will need some swap space in order to compile the C extensions for node. Bignum and the CN libraries can chew through some serious memory during compile. In regards to this, one of our users has put together a guide for T2.Micro servers: http://moneroocean.blogspot.com/2017/10/setup-of-xmr-node-proxy-on-free-tier.html

If not running on an Ubuntu 16.04 system, please make sure your kernel is at least 3.2 or higher, as older versions will not work for this.

Many smaller VMs come with ulimits set very low. We suggest looking into setting the ulimit higher. In particular, nofile (Number of files open) needs to be raised for high-usage instances.

In your packages.json, do a npm install, and it should pass.

Performance

The proxy gains a massive boost over a basic pool by accepting that the majority of the hashes submitted will not be valid (does not exceed the required difficulty of the pool). Due to this, the proxy doesn't bother with attempting to validate the hash state nor value until the share difficulty exceeds the pool difficulty.

In testing, we've seen AWS t2.micro instances take upwards of 2k connections, while t2.small taking 6k. The proxy is extremely light weight, and while there are more features on the way, it's our goal to keep the proxy as light weight as possible.

Configuration Guidelines

Please check the wiki for information on configuration

Developer Donations

If you'd like to make a one time donation, the addresses are as follows:

  • XMR - 499fS1Phq64hGeqV8p2AfXbf6Ax7gP6FybcMJq6Wbvg8Hw6xms8tCmdYpPsTLSaTNuLEtW4kF2DDiWCFcw4u7wSvFD8wFWE
  • AEON - WmsEg3RuUKCcEvFBtXcqRnGYfiqGJLP1FGBYiNMgrcdUjZ8iMcUn2tdcz59T89inWr9Vae4APBNf7Bg2DReFP5jr23SQqaDMT
  • ETN - etnkQMp3Hmsay2p7uxokuHRKANrMDNASwQjDUgFb5L2sDM3jqUkYQPKBkooQFHVWBzEaZVzfzrXoETX6RbMEvg4R4csxfRHLo1
  • SUMO - Sumoo1DGS7c9LEKZNipsiDEqRzaUB3ws7YHfUiiZpx9SQDhdYGEEbZjRET26ewuYEWAZ8uKrz6vpUZkEVY7mDCZyGnQhkLpxKmy

Known Working Pools

If you'd like to have your pool added, please make a pull request here, or contact MoneroOcean at support@moneroocean.stream!