You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-23Lines changed: 22 additions & 23 deletions
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,11 @@
1
1
# xmr-node-proxy
2
2
3
3
4
-
Setup Instructions
5
-
==================
4
+
## Setup Instructions
6
5
7
6
Based on a clean Ubuntu 16.04 LTS minimal install
8
7
9
-
Deployment via Installer
10
-
------------------------
8
+
## Deployment via Installer
11
9
12
10
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)
13
11
@@ -49,40 +47,41 @@ or using the pm2 monitor
49
47
pm2 monit
50
48
```
51
49
52
-
Known Issues
53
-
============
54
-
VM's with 512Mb of ram or less will need some swap space in order to compile the C extensions for node. Bignum and the CN libraries can chew some serious memory during compile. In regards to this, one of our users has put together a guide for T2.Micro servers: https://docs.google.com/document/d/1m8E4_pDwKuFo0TnWJaO13LDHqOmbL6YrzyR6FvzqGgU (Credit goes to MayDay30 for his work with this!)
50
+
## Known Issues
51
+
52
+
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: https://docs.google.com/document/d/1m8E4_pDwKuFo0TnWJaO13LDHqOmbL6YrzyR6FvzqGgU (Credit goes to MayDay30 for his work with this!)
55
53
56
54
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.
57
55
58
-
Many smaller VM's come with Ulimits set very low, we suggest looking into how to tweak the ulimits for your systems higher. In particularnofile (Number of files open) needs to be raised for high-usage instances.
56
+
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.
59
57
60
-
If your system doesn't have AES-NI, then it will throw an error during the node-multi-hashing install, as this is AES-NI required. If this is the case, go ahead and change the following line:
58
+
If your system doesn't have AES-NI, then it will throw an error during the node-multi-hashing install, as this requires AES-NI. If this is the case, go ahead and change the following line:
In your packages.json, then do a npm install, and it should pass.
65
62
63
+
In your `packages.json`, do a `npm install`, and it should pass.
64
+
65
+
66
+
## Performance
67
+
68
+
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.
66
69
67
-
Performance
68
-
===========
69
-
The proxy gains a massive boost over a basic pool, by accepting that the majority of the hashes submitted /will/ not be valid, as they do not exceed the required difficulty of the pool. Due to this the proxy really doesn't bother attempting to validate the hash state and/or value until the difficulty of the share exceeds the difficulty set by the pool.
70
+
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.
70
71
71
-
In testing, we've seen AWS T2.Micro instances taking upwards of 2k connections, with T2.Smalls 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.
72
+
## Configuration Guidelines
72
73
73
-
Configuration Guidelines
74
-
========================
75
74
Please check the [wiki](https://github.com/Snipa22/xmr-node-proxy/wiki/config_review) for information on configuration
76
75
76
+
## Developer Donations
77
+
78
+
The proxy is pre-configured for a 1% donation. This is easily toggled inside of it's configuration. If you'd like to make a one time donation, the addresses are as follows:
77
79
78
-
Developer Donations
79
-
===================
80
-
The proxy comes configured for a 1% donation, this is easily toggled inside of it's configuration. If you'd like to make a one time donation, the addresses are as follows:
If you need help installing the pool from scratch, please have your servers ready, which would be Ubuntu 16.04 servers, blank and clean, DNS records pointed. These need to be x86_64 boxes with AES-NI Available.
87
86
88
87
Installation asstiance is 4 XMR, with a 2 XMR deposit, with remainder to be paid on completion.
@@ -92,8 +91,8 @@ SSH access with a sudo-enabled user will be needed for installs, preferably the
92
91
93
92
Please contact Snipa at: proxy_installs@snipanet.com or via IRC on irc.freenode.net in #monero-pools
0 commit comments