2020-05-31 08:25:37 +00:00
|
|
|
|
{% include disclaimer.html translated="no" translationOutdated="no" %}
|
Simplify versioning system for user guides
This new approach doesn't require version numbers and make easier for contributors to understand the status
of the document. There are only 3 states:
- Outdated: The page is outdated and might not work as expected
- Untranslated: The page needs to be translated
- Translation outdated: The page is translated, but the original (English) document has been updated
To mark a guide as outdated, we change the boolean of the front matter entry 'outdated' in /resources/user-guides/GUIDE.
If 'False', the guide is updated. If 'True' all versions of the guide (English included) will show a warning at the bottom
of the page.
The other 2 states are related to the status of the translated pages and we control them from the language-specific
user guides: /_i18n/LANG/resources/user-guides/GUIDE. At the top of the page a snippet will include 2 parameters:
- translated: "yes" if the page is translated, "no" if it's not.
- translationOutdated: "yes" if the translation is outdated, "no" if it's not
This new system aims to be simpler than the precedent, avoiding to compare versioning numbers and using a higher level
system instead (yes, no, True, False). I also removed the middle way status 'only minor changes', because if there are
only minor changes that don't affect the usability of the guide, we don't need to point it out.
The old system was complex and people didn't use it. These changes will hopefully make things easier for translators and
other contributors.
2020-05-03 13:38:01 +00:00
|
|
|
|
|
2020-05-31 08:25:37 +00:00
|
|
|
|
## Wallet
|
2018-04-05 07:11:44 +00:00
|
|
|
|
|
2020-05-31 08:25:37 +00:00
|
|
|
|
Before starting, you already need to have a wallet configured and
|
|
|
|
|
working. The pool needs to know your wallet address to be able to send
|
|
|
|
|
payments there. See the [Accepting Monero guide]({{ site.baseurl
|
|
|
|
|
}}/get-started/accepting) for more information.
|
2018-04-05 07:11:44 +00:00
|
|
|
|
|
2020-05-31 08:25:37 +00:00
|
|
|
|
## Profitability
|
2018-04-05 07:11:44 +00:00
|
|
|
|
|
2021-07-28 09:38:05 +00:00
|
|
|
|
Before mining, you should decide if it is worth it or not for you. You have
|
|
|
|
|
to decide this for yourself, based on your power costs and the hardware that
|
|
|
|
|
you have available. There are many sites, such as
|
|
|
|
|
[CryptoCompare](https://www.cryptocompare.com/mining/calculator/xmr) that
|
|
|
|
|
allow you to enter your miner's speed and power draw, and it will show you
|
|
|
|
|
the profit (or loss) per week/month.
|
2018-04-05 07:11:44 +00:00
|
|
|
|
|
2020-05-31 08:25:37 +00:00
|
|
|
|
## Download Miner
|
2018-04-05 07:11:44 +00:00
|
|
|
|
|
2020-05-31 08:25:37 +00:00
|
|
|
|
The first step is to download mining software onto your computer.
|
2018-04-05 07:11:44 +00:00
|
|
|
|
|
2020-05-31 08:25:37 +00:00
|
|
|
|
### Windows
|
2018-04-05 07:11:44 +00:00
|
|
|
|
|
2021-07-28 09:38:05 +00:00
|
|
|
|
The XMRig developer provides pre-built binaries for Windows users. They are
|
|
|
|
|
available on the [GitHub release
|
2020-05-31 08:25:37 +00:00
|
|
|
|
page](https://github.com/xmrig/xmrig/releases/latest).
|
2018-04-05 07:11:44 +00:00
|
|
|
|
|
2021-07-28 09:38:05 +00:00
|
|
|
|
Scroll down until you see `xmrig-VERSION-msvc-win64.zip`. Download this file
|
|
|
|
|
and extract the archive somewhere memorable, like your desktop.
|
2018-04-05 07:11:44 +00:00
|
|
|
|
|
2020-05-31 08:25:37 +00:00
|
|
|
|
### Ubuntu Linux
|
2018-04-05 07:11:44 +00:00
|
|
|
|
|
2021-07-28 09:38:05 +00:00
|
|
|
|
The XMRig developer provides pre-built binaries for Ubuntu Bionic (18.04)
|
|
|
|
|
and Focal (20.04). They may work on other Ubuntu versions, and on other
|
2020-05-31 08:25:37 +00:00
|
|
|
|
distributions, but this is not guaranteed.
|
2018-04-05 07:11:44 +00:00
|
|
|
|
|
2020-05-31 08:25:37 +00:00
|
|
|
|
These binaries are available on the [GitHub release
|
|
|
|
|
page](https://github.com/xmrig/xmrig/releases/latest).
|
2018-04-05 07:11:44 +00:00
|
|
|
|
|
2021-07-28 09:38:05 +00:00
|
|
|
|
Scroll down to 'Assets' until you see the correct version for your
|
|
|
|
|
system. Download this file, extract the archive somewhere memorable, like
|
|
|
|
|
your desktop.
|
2018-04-05 07:11:44 +00:00
|
|
|
|
|
2021-07-28 09:38:05 +00:00
|
|
|
|
### Other distributions and operative systems
|
2018-04-05 07:11:44 +00:00
|
|
|
|
|
2021-07-28 09:38:05 +00:00
|
|
|
|
Binaries are available for multiple distributions and operative systems, but
|
|
|
|
|
you can also build the miner by yourself. Take a loot at [XMrig's
|
|
|
|
|
docs](https://xmrig.com/docs/miner)
|
2018-04-05 07:11:44 +00:00
|
|
|
|
|
2020-05-31 08:25:37 +00:00
|
|
|
|
## Selecting a pool
|
2018-04-05 07:11:44 +00:00
|
|
|
|
|
2020-05-31 08:25:37 +00:00
|
|
|
|
There are lots of pools to choose from. You can find a list at
|
|
|
|
|
[miningpoolstats.stream/monero](https://miningpoolstats.stream/monero).
|
2018-04-05 07:11:44 +00:00
|
|
|
|
|
2021-07-28 09:38:05 +00:00
|
|
|
|
Choosing a larger pool means that you will see more frequent (but smaller)
|
|
|
|
|
payouts, but choosing a smaller pools helps keep the network
|
|
|
|
|
decentralised. [Miners will not lose any revenue by mining on a smaller
|
|
|
|
|
pool](https://redd.it/g6uh2l).
|
2018-04-05 07:11:44 +00:00
|
|
|
|
|
2020-05-31 08:25:37 +00:00
|
|
|
|
## Configuring the miner
|
2018-04-05 07:11:44 +00:00
|
|
|
|
|
2021-07-28 09:38:05 +00:00
|
|
|
|
See the [official docs](https://xmrig.com/docs/miner/config), for
|
|
|
|
|
instructions and suggestions.
|
2020-05-31 08:25:37 +00:00
|
|
|
|
|
|
|
|
|
## Starting the miner
|
|
|
|
|
|
|
|
|
|
Windows users can double click on xmrig.exe. Users of other operating
|
2021-07-28 09:38:05 +00:00
|
|
|
|
systems should `cd` into the directory that contains XMRig and then type
|
|
|
|
|
`./xmrig` and press return.
|
2020-05-31 08:25:37 +00:00
|
|
|
|
|
|
|
|
|
If you see green messages saying that shares have been accepted,
|
|
|
|
|
congratulations, everything is working!
|
|
|
|
|
|
|
|
|
|
## Troubleshooting
|
|
|
|
|
|
|
|
|
|
### Anti-virus keeps removing XMRig
|
|
|
|
|
|
2021-07-28 09:38:05 +00:00
|
|
|
|
Some anti-viruses flag XMRig as malware because it is often deployed to
|
|
|
|
|
infected computers to mine without the owner's consent. As it is your
|
|
|
|
|
computer and you are configuring the miner to mine for you, it is safe to
|
|
|
|
|
add XMRig to your anti-virus whitelist.
|
2020-05-31 08:25:37 +00:00
|
|
|
|
|
|
|
|
|
### Cannot read/set MSR
|
|
|
|
|
|
|
|
|
|
On some CPUs, XMRig tries to increase performance by disabling certain
|
2021-07-28 09:38:05 +00:00
|
|
|
|
features like your CPU's instruction prefetcher. These operations require
|
|
|
|
|
root/administrator, so try right clicking xmrig.exe and running it as
|
|
|
|
|
administrator, or running `sudo ./xmrig` on other systems.
|
2020-05-31 08:25:37 +00:00
|
|
|
|
|
|
|
|
|
### Algo not known
|
|
|
|
|
|
2021-07-28 09:38:05 +00:00
|
|
|
|
Find the line in config.json that says `algo: null` and change it to `algo:
|
|
|
|
|
"rx/0"`. By default, XMRig expects the pool to tell it which hashing
|
|
|
|
|
algorithm to use.
|
2020-05-31 08:25:37 +00:00
|
|
|
|
|
|
|
|
|
### Huge Pages 0%
|
|
|
|
|
|
|
|
|
|
#### Allowing large pages on Windows
|
|
|
|
|
|
2021-07-28 09:38:05 +00:00
|
|
|
|
Taken from [the
|
|
|
|
|
MSDN](https://docs.microsoft.com/en-us/sql/database-engine/configure-windows/enable-the-lock-pages-in-memory-option-windows?view=sql-server-ver15):
|
2020-05-31 08:25:37 +00:00
|
|
|
|
|
2021-03-26 10:08:06 +00:00
|
|
|
|
1. On the Start menu, click Run. In the Open box, type gpedit.msc.
|
2021-07-28 09:38:05 +00:00
|
|
|
|
2. On the Local Group Policy Editor console, expand Computer Configuration,
|
|
|
|
|
and then expand Windows Settings.
|
2018-04-05 07:11:44 +00:00
|
|
|
|
3. Expand Security Settings, and then expand Local Policies.
|
|
|
|
|
4. Select the User Rights Assignment folder.
|
|
|
|
|
5. The policies will be displayed in the details pane.
|
|
|
|
|
6. In the pane, double-click Lock pages in memory.
|
2021-07-28 09:38:05 +00:00
|
|
|
|
7. In the Local Security Setting – Lock pages in memory dialog box, click
|
|
|
|
|
Add User or Group.
|
|
|
|
|
8. In the Select Users, Service Accounts, or Groups dialog box, add an
|
|
|
|
|
account that you will run the miner on
|
2018-04-05 07:11:44 +00:00
|
|
|
|
9. Reboot for change to take effect.
|
2020-05-31 08:25:37 +00:00
|
|
|
|
|
|
|
|
|
You may also need to launch the miner as administrator.
|
|
|
|
|
|
|
|
|
|
#### Allowing large pages on Linux
|
|
|
|
|
|
2021-07-28 09:38:05 +00:00
|
|
|
|
Firstly stop the miner (if it's running), run the following commands to
|
|
|
|
|
enable large pages and then start the miner as root:
|
2020-05-31 08:25:37 +00:00
|
|
|
|
|
|
|
|
|
sudo sysctl -w vm.nr_hugepages=1168
|
|
|
|
|
sudo ./xmrig
|
|
|
|
|
|
2021-07-28 09:38:05 +00:00
|
|
|
|
You may have to increase 1168 depending on how many NUMA nodes your CPU(s)
|
|
|
|
|
have.
|
2020-05-31 08:25:37 +00:00
|
|
|
|
|
|
|
|
|
#### Allowing large pages on macOS
|
|
|
|
|
|
|
|
|
|
Huge pages are not supported on macOS.
|
|
|
|
|
|
|
|
|
|
### Balance Not Increasing
|
|
|
|
|
|
|
|
|
|
Most pools are <abbr title="Pay Per Last N Shares">PPLNS</abbr> pools,
|
|
|
|
|
which means that you only get paid when a miner on the pool finds a
|
|
|
|
|
block. If the pool you are mining on is small, this can take a few
|
|
|
|
|
days to weeks.
|
|
|
|
|
|
2021-07-28 09:38:05 +00:00
|
|
|
|
Additionally, any blocks found must mature before they can be paid out. This
|
|
|
|
|
takes 60 blocks (approx. 2 hours).
|
2020-05-31 08:25:37 +00:00
|
|
|
|
|
|
|
|
|
## Getting Help
|
|
|
|
|
|
|
|
|
|
An active Monero mining community on Reddit is
|
2021-07-28 09:38:05 +00:00
|
|
|
|
[/r/MoneroSupport](https://www.reddit.com/r/MoneroSupport/). You can also
|
|
|
|
|
join [#monero-pools on
|
|
|
|
|
Libera](https://web.libera.chat/?channel=#monero-pools) or Matrix
|
|
|
|
|
(#monero-pools:monero.social).
|
2020-05-31 08:25:37 +00:00
|
|
|
|
|
|
|
|
|
## Going Futher
|
|
|
|
|
|
2021-07-28 09:38:05 +00:00
|
|
|
|
* Consider using a subaddress just for mining, to prevent your address being
|
|
|
|
|
linked to different services.
|
2020-05-31 08:25:37 +00:00
|
|
|
|
* [Consider using Tor to connect to the
|
2021-07-28 09:38:05 +00:00
|
|
|
|
pool](https://xmrig.com/docs/miner/tor) (or to a hidden service pool like
|
|
|
|
|
HashVault, RespectXMR and MoneroOcean). This hides mining activity from
|
|
|
|
|
your ISP, and prevents the pool from knowing who you are.
|