Skip to content

Commit 13c31eb

Browse files
committed
redirect to new xmr-stak repo
1 parent 7ad999d commit 13c31eb

File tree

1 file changed

+3
-199
lines changed

1 file changed

+3
-199
lines changed

README.md

Lines changed: 3 additions & 199 deletions
Original file line numberDiff line numberDiff line change
@@ -1,201 +1,5 @@
1-
# XMR-Stak-CPU - Monero mining software
1+
# XMR-Stak is now supporting CPU, AMD and NVIDIA GPUs in a unified miner.
22

3-
XMR-Stak is a universal Stratum pool miner. This is the CPU-mining version; there is also an [AMD GPU version](https://github.com/fireice-uk/xmr-stak-amd) and an [NVIDA GPU version](https://github.com/fireice-uk/xmr-stak-nvidia)
3+
Our new repository is https://github.com/fireice-uk/xmr-stak.
44

5-
## HTML reports
6-
<img src="https://gist.githubusercontent.com/fireice-uk/2da301131ac01695ff79539a27b81d68/raw/4c09cdeee86f94df2e9dd86b927e64aded6184f5/xmr-stak-cpu-hashrate.png" width="260"> <img src="https://gist.githubusercontent.com/fireice-uk/2da301131ac01695ff79539a27b81d68/raw/4c09cdeee86f94df2e9dd86b927e64aded6184f5/xmr-stak-cpu-results.png" width="260"> <img src="https://gist.githubusercontent.com/fireice-uk/2da301131ac01695ff79539a27b81d68/raw/4c09cdeee86f94df2e9dd86b927e64aded6184f5/xmr-stak-cpu-connection.png" width="260">
7-
8-
## HTML and JSON API report configuraton
9-
10-
To configure the reports shown above you need to edit the httpd_port variable. Then enable wifi on your phone and navigate to [miner ip address]:[httpd_port] in your phone browser. If you want to use the data in scripts, you can get the JSON version of the data at url [miner ip address]:[httpd_port]/api.json
11-
12-
## Usage on Windows
13-
1) Edit the config.txt file to enter your pool login and password.
14-
2) Double click the exe file.
15-
16-
XMR-Stak should compile on any C++11 compliant compiler.
17-
```
18-
-----BEGIN PGP SIGNED MESSAGE-----
19-
Hash: SHA256
20-
21-
sha1sum
22-
d34a0ba0dd7b3b1f900a7e02772e197e974b4a73 libeay32.dll
23-
2ee9966a0fc163da58408d91be36b84fa287c10b ssleay32.dll
24-
e4d8a974e58985214de163df0c1ed0f54250d7ee xmr-stak-cpu.exe
25-
ae0153ff98df82022b2c392d6a17c5f3614f6a50 xmr-stak-cpu-notls.exe
26-
27-
sha3sum
28-
05003137a87313c81d6c348c9b96411c95d48dc22c35f36c39129747 libeay32.dll
29-
133c065d9ef2c93396382e2ba5d8c3ca8c6a57c6beb0159cb9a4b6c5 ssleay32.dll
30-
7bfc30b06524dc9139a3157e2661d2a6f5720738dde8e490f05cc8e2 xmr-stak-cpu.exe
31-
005fb81fc3711a97b2ce65bad0ca97318d878dc793a8cba99c7d1f6f xmr-stak-cpu-notls.exe
32-
33-
date
34-
Wed 19 Jul 21:18:58 BST 2017
35-
-----BEGIN PGP SIGNATURE-----
36-
Version: GnuPG v2
37-
38-
iQEcBAEBCAAGBQJZb77XAAoJEPsk95p+1Bw0GU4H/26sBwJzYSeWoLwo0LdmOPk3
39-
19n+svFYnz6NlxAjs+fvuTK992ilLMy2pa4PHKhot2oyZIgt2rRaFsvRADcHVraG
40-
nsIh4Oq31T9epZI0WxIH5FJlDx30fdGkpMTu9xt6ta2JXsmkDiCoZxmETuljB7Rw
41-
xvnKeHiuTccp73C6Nd7dkuiemsOw0FZA7XXS/Kmwqm7n8BtCztY70R6SVN7QFbCz
42-
C49s0A9cT4UbAUPuu8KvxFozmJHA/wDBYHgkq95Y6n/q116+Sc9BpdF8j+qK4YzZ
43-
uM+B10XY0g7Qv376UoJRYKokpVaBxF08nD+JXLdL+zfQvnEfKgrhTnjaTkWFfEY=
44-
=jpgE
45-
-----END PGP SIGNATURE-----
46-
```
47-
## Compile guides
48-
49-
- [Free BSD](FREEBSDCOMPILE.md)
50-
- [Linux](LINUXCOMPILE.md)
51-
- [Windows](WINCOMPILE.md)
52-
53-
54-
#### CPU mining performance
55-
56-
Performance is nearly identical to the closed source paid miners. Here are some numbers:
57-
58-
* **I7-2600K** - 266 H/s
59-
* **I7-6700** - 276 H/s (with a separate GPU miner)
60-
* **Dual X5650** - 466 H/s (depends on NUMA)
61-
* **Dual E5640** - 365 H/s (same as above)
62-
63-
## Default dev donation
64-
By default the miner will donate 2% of the hashpower (2 minute in 100 minutes) to my pool. If you want to change that, edit **donate-level.h** before you build the binaries.
65-
66-
If you want to donate directly to support further development, here is my wallet
67-
68-
fireice-uk:
69-
```
70-
4581HhZkQHgZrZjKeCfCJxZff9E3xCgHGF25zABZz7oR71TnbbgiS7sK9jveE6Dx6uMs2LwszDuvQJgRZQotdpHt1fTdDhk
71-
```
72-
73-
psychocrypt:
74-
```
75-
43NoJVEXo21hGZ6tDG6Z3g4qimiGdJPE6GRxAmiWwm26gwr62Lqo7zRiCJFSBmbkwTGNuuES9ES5TgaVHceuYc4Y75txCTU
76-
```
77-
78-
## Common Issues
79-
80-
**SeLockMemoryPrivilege failed**
81-
82-
Please see [config.txt](config.txt) under section **LARGE PAGE SUPPORT**
83-
84-
For Windows 7 pro, or Windows 8 and above see [this article](https://msdn.microsoft.com/en-gb/library/ms190730.aspx) (make sure to reboot afterwards!).
85-
86-
For Windows 7 Home :
87-
88-
1) Download and install [Windows Server 2003 Resource Kit Tools](https://www.microsoft.com/en-us/download/details.aspx?id=17657). Ignore incompatiablity warning during installation.
89-
90-
2) In cmd or power shell: `ntrights -u %USERNAME% +r SeLockMemoryPrivilege` (where %USERNAME% is the user that will be running the program. This command needs to be run as admin)
91-
92-
3) Reboot.
93-
94-
Reference: http://rybkaforum.net/cgi-bin/rybkaforum/topic_show.pl?pid=259791#pid259791
95-
96-
*Warning: do not download ntrights.exe from any other site other then the offical Microsoft download page.*
97-
98-
**VirtualAlloc failed**
99-
100-
If you set up the user rights properly (see above), and your system has 4-8GB of RAM (50%+ use), there is a significant chance that there simply won't be a large enough chunk of contiguous memory because Windows is fairly bad at mitigating memory fragmentation.
101-
102-
If that happens, disable all auto-starting applications and run the miner after a reboot.
103-
104-
**msvcp140.dll and vcruntime140.dll not available errors**
105-
106-
Download and install this [runtime package](https://go.microsoft.com/fwlink/?LinkId=746572) from Microsoft. *Warning: Do NOT use "missing dll" sites - dll's are exe files with another name, and it is a fairly safe bet that any dll on a shady site like that will be trojaned. Please download offical runtimes from Microsoft above.*
107-
108-
109-
**Error: MEMORY ALLOC FAILED: mmap failed**
110-
111-
From [config.txt](config.txt):
112-
113-
On Linux you will need to configure large page support `sudo sysctl -w vm.nr_hugepages=128` and increase your
114-
ulimit -l. To do do this you need to add following lines to /etc/security/limits.conf:
115-
116-
* soft memlock 262144
117-
* hard memlock 262144
118-
119-
Save file. You WILL need to log out and log back in for these settings to take affect on your user (no need to reboot, just relogin in your session).
120-
121-
You can also do it Windows-style and simply run-as-root, but this is NOT recommended for security reasons.
122-
123-
**Illegal instruction (core dumped)**
124-
125-
This typically means you are trying to run it on a CPU that does not have [AES](https://en.wikipedia.org/wiki/AES_instruction_set). This only happens on older version of miner, new version gives better error message (but still wont' work since your CPU doesn't support the required instructions).
126-
127-
128-
## Advanced Compile Options
129-
130-
The build system is CMake, if you are not familiar with CMake you can learn more [here](https://cmake.org/runningcmake/).
131-
132-
### Short Description
133-
134-
There are two easy ways to set variables for `cmake` to configure *xmr-stak-cpu*
135-
- use the ncurses GUI
136-
- `ccmake .`
137-
- edit your options
138-
- end the GUI by pressing the key `c`(create) and than `g`(generate)
139-
- set Options on the command line
140-
- enable a option: `cmake . -DNAME_OF_THE_OPTION=ON`
141-
- disable a option `cmake . -DNAME_OF_THE_OPTION=OFF`
142-
- set a value `cmake . -DNAME_OF_THE_OPTION=value`
143-
144-
After the configuration you need to call
145-
`make install` for slow sequential build
146-
or
147-
`make -j install` for faster parallel build
148-
and install.
149-
150-
### xmr-stak-cpu Compile Options
151-
- `CMAKE_INSTALL_PREFIX` install miner to the home folder
152-
- `cmake . -DCMAKE_INSTALL_PREFIX=$HOME/xmr-stak-cpu`
153-
- you can find the binary and the `config.txt` file after `make install` in `$HOME/xmr-stak-cpu/bin`
154-
- `CMAKE_LINK_STATIC` link libgcc and libstdc++ libraries static (default OFF)
155-
- disable with `cmake . -DCMAKE_LINK_STATIC=ON`
156-
-`CMAKE_BUILD_TYPE` set the build type
157-
- valid options: `Release` or `Debug`
158-
- you should always keep `Release` for your productive miners
159-
- `MICROHTTPD_ENABLE` allow to disable/enable the dependency *microhttpd*
160-
- by default enabled
161-
- there is no *http* interface available if option is disabled: `cmake . -DMICROHTTPD_ENABLE=OFF`
162-
- `OpenSSL_ENABLE` allow to disable/enable the dependency *OpenSSL*
163-
- by default enabled
164-
- it is not possible to connect to a *https* secured pool if option is disabled: `cmake . -DOpenSSL_ENABLE=OFF`
165-
- `HWLOC_ENABLE` allow to disable/enable the dependency *hwloc*
166-
- by default enabled
167-
- the config suggestion is not optimal if option is disabled: `cmake . -DHWLOC_ENABLE=OFF`
168-
169-
## PGP Key
170-
```
171-
-----BEGIN PGP PUBLIC KEY BLOCK-----
172-
Version: GnuPG v2
173-
174-
mQENBFhYUmUBCAC6493W5y1MMs38ApRbI11jWUqNdFm686XLkZWGDfYImzL6pEYk
175-
RdWkyt9ziCyA6NUeWFQYniv/z10RxYKq8ulVVJaKb9qPGMU0ESfdxlFNJkU/pf28
176-
sEVBagGvGw8uFxjQONnBJ7y7iNRWMN7qSRS636wN5ryTHNsmqI4ClXPHkXkDCDUX
177-
QvhXZpG9RRM6jsE3jBGz/LJi3FyZLo/vB60OZBODJ2IA0wSR41RRiOq01OqDueva
178-
9jPoAokNglJfn/CniQ+lqUEXj1vjAZ1D5Mn9fISzA/UPen5Z7Sipaa9aAtsDBOfP
179-
K9iPKOsWa2uTafoyXgiwEVXCCeMMUjCGaoFBABEBAAG0ImZpcmVpY2VfdWsgPGZp
180-
cmVpY2UueG1yQGdtYWlsLmNvbT6JATcEEwEIACEFAlhYUmUCGwMFCwkIBwIGFQgJ
181-
CgsCBBYCAwECHgECF4AACgkQ+yT3mn7UHDTEcQf8CMhqaZ0IOBxeBnsq5HZr2X6z
182-
E5bODp5cPs6ha1tjH3CWpk1AFeykNtXH7kPW9hcDt/e4UQtcHs+lu6YU59X7xLJQ
183-
udOkpWdmooJMXRWS/zeeon4ivT9d69jNnwubh8EJOyw8xm/se6n48BcewfHekW/6
184-
mVrbhLbF1dnuUGXzRN1WxsUZx3uJd2UvrkJhAtHtX92/qIVhT0+3PXV0bmpHURlK
185-
YKhhm8dPLV9jPX8QVRHQXCOHSMqy/KoWEe6CnT0Isbkq3JtS3K4VBVeTX9gkySRc
186-
IFxrNJdXsI9BxKv4O8yajP8DohpoGLMDKZKSO0yq0BRMgMh0cw6Lk22uyulGALkB
187-
DQRYWFJlAQgAqikfViOmIccCZKVMZfNHjnigKtQqNrbJpYZCOImql4FqbZu9F7TD
188-
9HIXA43SPcwziWlyazSy8Pa9nCpc6PuPPO1wxAaNIc5nt+w/x2EGGTIFGjRoubmP
189-
3i5jZzOFYsvR2W3PgVa3/ujeYYJYo1oeVeuGmmJRejs0rp1mbvBSKw1Cq6C4cI0x
190-
GTY1yXFGLIgdfYNMmiLsTy1Qwq8YStbFKeUYAMMG3128SAIaT3Eet911f5Jx4tC8
191-
6kWUr6PX1rQ0LQJqyIsLq9U53XybUksRfJC9IEfgvgBxRBHSD8WfqEhHjhW1VsZG
192-
dcYgr7A1PIneWsCEY+5VUnqTlt2HPaKweQARAQABiQEfBBgBCAAJBQJYWFJlAhsM
193-
AAoJEPsk95p+1Bw0Pr8H/0vZ6U2zaih03jOHOvsrYxRfDXSmgudOp1VS45aHIREd
194-
2nrJ+drleeFVyb14UQqO/6iX9GuDX2yBEHdCg2aljeP98AaMU//RiEtebE6CUWsL
195-
HPVXHIkxwBCBe0YkJINHUQqLz/5f6qLsNUp1uTH2++zhdBWvg+gErTYbx8aFMFYH
196-
0GoOtqE5rtlAh5MTvDZm+UcDwKJCxhrLaN3R3dDoyrDNRTgHQQuX5/opJBiUnVNK
197-
d+vugnxzpMIJQP11yCZkz/KxV8zQ2QPMuZdAoh3znd/vGCJcp0rWphn4pqxA4vDp
198-
c4hC0Yg9Dha1OoE5CJCqVL+ic4vAyB1urAwBlsd/wH8=
199-
=B5I+
200-
-----END PGP PUBLIC KEY BLOCK-----
201-
```
5+
Please use our new miner, the old version is retired and unsupported.

0 commit comments

Comments
 (0)