2014-08-30 08:58:01 +02:00
# Monero
2018-01-07 06:05:16 +01:00
Copyright (c) 2014-2018 The Monero Project.
2017-10-19 15:21:52 +02:00
Portions Copyright (c) 2012-2013 The Cryptonote developers.
2014-08-30 08:58:01 +02:00
2017-12-04 20:49:40 +01:00
## Development resources
2014-08-30 08:58:01 +02:00
2016-07-20 14:22:17 +02:00
- Web: [getmonero.org ](https://getmonero.org )
- Forum: [forum.getmonero.org ](https://forum.getmonero.org )
- Mail: [dev@getmonero.org ](mailto:dev@getmonero.org )
2016-09-03 21:47:00 +02:00
- GitHub: [https://github.com/monero-project/monero ](https://github.com/monero-project/monero )
2016-10-31 22:00:50 +01:00
- IRC: [#monero-dev on Freenode ](http://webchat.freenode.net/?randomnick=1&channels=%23monero-dev&prompt=1&uio=d4 )
2014-08-30 08:58:01 +02:00
2017-12-04 20:49:40 +01:00
## Vulnerability response
2017-09-12 00:00:21 +02:00
2017-12-05 16:54:51 +01:00
- Our [Vulnerability Response Process ](https://github.com/monero-project/meta/blob/master/VULNERABILITY_RESPONSE_PROCESS.md ) encourages responsible disclosure
2017-09-12 00:00:21 +02:00
- We are also available via [HackerOne ](https://hackerone.com/monero )
2018-05-06 20:23:53 +02:00
## Announcements
- You can subscribe to an [announcement listserv ](https://lists.getmonero.org ) to get critical announcements from the Monero core team. The announcement list can be very helpful for knowing when software updates are needed.
2016-10-31 21:55:57 +01:00
## Build
| Operating System | Processor | Status |
| --------------------- | -------- |--------|
| Ubuntu 16.04 | i686 | [](https://build.getmonero.org/builders/monero-static-ubuntu-i686)
2016-11-05 02:17:08 +01:00
| Ubuntu 16.04 | amd64 | [](https://build.getmonero.org/builders/monero-static-ubuntu-amd64)
2016-10-31 21:55:57 +01:00
| Ubuntu 16.04 | armv7 | [](https://build.getmonero.org/builders/monero-static-ubuntu-arm7)
2016-11-06 19:11:16 +01:00
| Debian Stable | armv8 | [](https://build.getmonero.org/builders/monero-static-debian-armv8)
2016-10-31 21:55:57 +01:00
| OSX 10.10 | amd64 | [](https://build.getmonero.org/builders/monero-static-osx-10.10)
| OSX 10.11 | amd64 | [](https://build.getmonero.org/builders/monero-static-osx-10.11)
| OSX 10.12 | amd64 | [](https://build.getmonero.org/builders/monero-static-osx-10.12)
2017-02-22 03:49:29 +01:00
| FreeBSD 11 | amd64 | [](https://build.getmonero.org/builders/monero-static-freebsd64)
| DragonFly BSD 4.6 | amd64 | [](https://build.getmonero.org/builders/monero-static-dragonflybsd-amd64)
2016-10-31 21:55:57 +01:00
| Windows (MSYS2/MinGW) | i686 | [](https://build.getmonero.org/builders/monero-static-win32)
2016-11-05 02:17:08 +01:00
| Windows (MSYS2/MinGW) | amd64 | [](https://build.getmonero.org/builders/monero-static-win64)
2016-10-31 21:55:57 +01:00
2016-11-06 19:11:16 +01:00
## Coverage
2016-10-31 21:55:57 +01:00
2016-11-06 19:11:16 +01:00
| Type | Status |
|-----------|--------|
2016-11-06 19:21:08 +01:00
| Coverity | [](https://scan.coverity.com/projects/9657/)
2016-11-06 19:11:16 +01:00
| Coveralls | [](https://coveralls.io/github/monero-project/monero?branch=master)
| License | [](https://opensource.org/licenses/BSD-3-Clause)
2016-10-31 21:55:57 +01:00
2014-08-30 08:58:01 +02:00
## Introduction
2016-08-28 14:13:52 +02:00
Monero is a private, secure, untraceable, decentralised digital currency. You are your bank, you control your funds, and nobody can trace your transfers unless you allow them to do so.
2014-08-30 08:58:01 +02:00
**Privacy:** Monero uses a cryptographically sound system to allow you to send and receive funds without your transactions being easily revealed on the blockchain (the ledger of transactions that everyone has). This ensures that your purchases, receipts, and all transfers remain absolutely private by default.
2016-10-02 23:41:56 +02:00
**Security:** Using the power of a distributed peer-to-peer consensus network, every transaction on the network is cryptographically secured. Individual wallets have a 25 word mnemonic seed that is only displayed once, and can be written down to backup the wallet. Wallet files are encrypted with a passphrase to ensure they are useless if stolen.
2014-08-30 08:58:01 +02:00
2015-05-30 18:42:55 +02:00
**Untraceability:** By taking advantage of ring signatures, a special property of a certain type of cryptography, Monero is able to ensure that transactions are not only untraceable, but have an optional measure of ambiguity that ensures that transactions cannot easily be tied back to an individual user or computer.
2014-08-30 08:58:01 +02:00
2017-12-04 20:49:40 +01:00
## About this project
2014-08-30 08:58:01 +02:00
This is the core implementation of Monero. It is open source and completely free to use without restrictions, except for those specified in the license agreement below. There are no restrictions on anyone creating an alternative implementation of Monero that uses the protocol and network in a compatible manner.
2016-08-28 14:13:52 +02:00
As with many development projects, the repository on Github is considered to be the "staging" area for the latest changes. Before changes are merged into that branch on the main repository, they are tested by individual developers in their own branches, submitted as a pull request, and then subsequently tested by contributors who focus on testing and code reviews. That having been said, the repository should be carefully considered before using it in a production environment, unless there is a patch in the repository for a particular show-stopping issue you are experiencing. It is generally a better idea to use a tagged release for stability.
2014-08-30 08:58:01 +02:00
2017-04-11 21:09:37 +02:00
**Anyone is welcome to contribute to Monero's codebase!** If you have a fix or code change, feel free to submit it as a pull request directly to the "master" branch. In cases where the change is relatively small or does not affect other parts of the codebase it may be merged in immediately by any one of the collaborators. On the other hand, if the change is particularly large or complex, it is expected that it will be discussed at length either well in advance of the pull request being submitted, or even directly on the pull request.
2014-08-30 08:58:01 +02:00
2017-12-04 20:49:40 +01:00
## Supporting the project
2015-02-03 12:05:28 +01:00
2017-12-17 17:52:16 +01:00
Monero is a 100% community-sponsored endeavor. If you want to join our efforts, the easiest thing you can do is support the project financially. Both Monero and Bitcoin donations can be made to **donate.getmonero.org** if using a client that supports the [OpenAlias ](https://openalias.org ) standard. Alternatively you can send XMR to the Monero donation address via the `donate` command (type `help` in the command-line wallet for details).
2015-02-03 12:05:28 +01:00
2016-08-22 22:37:14 +02:00
The Monero donation address is: `44AFFq5kSiGBoZ4NMDwYtN18obc8AemS33DBLWs3H7otXft3XjrpDtQGv7SqSsaBYBb98uNbr2VBBEt7f2wfn3RVGQBEP3A` (viewkey: `f359631075708155cc3d92a32b75a7d02a5dcf27756707b47a2b31b21c389501` )
2015-02-03 12:05:28 +01:00
2016-08-22 22:37:14 +02:00
The Bitcoin donation address is: `1KTexdemPdxSBcG55heUuTjDRYqbC5ZL8H`
2015-02-03 12:05:28 +01:00
Core development funding and/or some supporting services are also graciously provided by sponsors:
2016-08-20 07:22:12 +02:00
[<img width="80" src="https://static.getmonero.org/images/sponsors/mymonero.png"/> ](https://mymonero.com )
[<img width="150" src="https://static.getmonero.org/images/sponsors/kitware.png?1"/> ](http://kitware.com )
[<img width="100" src="https://static.getmonero.org/images/sponsors/dome9.png"/> ](http://dome9.com )
[<img width="150" src="https://static.getmonero.org/images/sponsors/araxis.png"/> ](http://araxis.com )
[<img width="150" src="https://static.getmonero.org/images/sponsors/jetbrains.png"/> ](http://www.jetbrains.com/ )
[<img width="150" src="https://static.getmonero.org/images/sponsors/navicat.png"/> ](http://www.navicat.com/ )
2016-08-24 17:47:53 +02:00
[<img width="150" src="https://static.getmonero.org/images/sponsors/symas.png"/> ](http://www.symas.com/ )
2015-02-03 12:05:28 +01:00
There are also several mining pools that kindly donate a portion of their fees, [a list of them can be found on our Bitcointalk post ](https://bitcointalk.org/index.php?topic=583449.0 ).
2014-08-30 08:58:01 +02:00
## License
2016-06-22 01:01:49 +02:00
See [LICENSE ](LICENSE ).
2014-08-30 08:58:01 +02:00
2017-12-05 02:47:39 +01:00
## Contributing
2017-04-09 21:32:25 +02:00
If you want to help out, see [CONTRIBUTING ](CONTRIBUTING.md ) for a set of guidelines.
2018-03-21 17:27:21 +01:00
## Scheduled software upgrades
2016-10-11 05:22:13 +02:00
2018-03-21 17:27:21 +01:00
Monero uses a fixed-schedule software upgrade (hard fork) mechanism to implement new features. This means that users of Monero (end users and service providers) should run current versions and upgrade their software on a regular schedule. Software upgrades occur during the months of April and October. The required software for these upgrades will be available prior to the scheduled date. Please check the repository prior to this date for the proper Monero software version. Below is the historical schedule and the projected schedule for the next upgrade.
2017-03-09 00:39:49 +01:00
Dates are provided in the format YYYY-MM-DD.
2016-10-11 05:22:13 +02:00
2017-12-05 21:42:23 +01:00
| Software upgrade block height | Date | Fork version | Minimum Monero version | Recommended Monero version | Details |
2017-09-20 23:32:56 +02:00
| ------------------------------ | -----------| ----------------- | ---------------------- | -------------------------- | ---------------------------------------------------------------------------------- |
| 1009827 | 2016-03-22 | v2 | v0.9.4 | v0.9.4 | Allow only >= ringsize 3, blocktime = 120 seconds, fee-free blocksize 60 kb |
| 1141317 | 2016-09-21 | v3 | v0.9.4 | v0.10.0 | Splits coinbase into denominations |
| 1220516 | 2017-01-05 | v4 | v0.10.1 | v0.10.2.1 | Allow normal and RingCT transactions |
| 1288616 | 2017-04-15 | v5 | v0.10.3.0 | v0.10.3.1 | Adjusted minimum blocksize and fee algorithm |
| 1400000 | 2017-09-16 | v6 | v0.11.0.0 | v0.11.0.0 | Allow only RingCT transactions, allow only >= ringsize 5 |
2018-03-17 17:14:25 +01:00
| 1546000 | 2018-04-06 | v7 | v0.12.0.0 | v0.12.0.0 | Cryptonight variant 1, ringsize >= 7, sorted inputs
2018-03-21 17:27:21 +01:00
| XXXXXXX | 2018-10-XX | XX | XXXXXXXXX | XXXXXXXXX | X
2017-09-20 23:32:56 +02:00
2018-03-07 16:39:18 +01:00
X's indicate that these details have not been determined as of commit date.
2016-10-11 05:22:13 +02:00
2017-12-05 02:47:39 +01:00
## Release staging schedule and protocol
2017-11-19 19:16:34 +01:00
2018-03-21 17:27:21 +01:00
Approximately three months prior to a scheduled software upgrade, a branch from Master will be created with the new release version tag. Pull requests that address bugs should then be made to both Master and the new release branch. Pull requests that require extensive review and testing (generally, optimizations and new features) should *not* be made to the release branch.
2017-11-19 19:16:34 +01:00
2017-12-04 20:49:40 +01:00
## Compiling Monero from source
2016-08-28 10:15:55 +02:00
### Dependencies
2016-08-20 07:00:41 +02:00
2017-12-05 02:47:39 +01:00
The following table summarizes the tools and libraries required to build. A
2016-08-30 01:19:49 +02:00
few of the libraries are also included in this repository (marked as
"Vendored"). By default, the build uses the library installed on the system,
and ignores the vendored sources. However, if no library is found installed on
the system, then the vendored source will be built and used. The vendored
sources are also used for statically-linked builds because distribution
packages often include only shared library binaries (`.so`) but not static
library archives (`.a`).
2017-12-26 15:13:41 +01:00
| Dep | Min. version | Vendored | Debian/Ubuntu pkg | Arch pkg | Fedora | Optional | Purpose |
| ------------ | ------------- | -------- | ------------------ | ------------ | ----------------- | -------- | -------------- |
| GCC | 4.7.3 | NO | `build-essential` | `base-devel` | `gcc` | NO | |
2018-03-21 18:16:06 +01:00
| CMake | 3.0.0 | NO | `cmake` | `cmake` | `cmake` | NO | |
2017-12-26 15:13:41 +01:00
| pkg-config | any | NO | `pkg-config` | `base-devel` | `pkgconf` | NO | |
| Boost | 1.58 | NO | `libboost-all-dev` | `boost` | `boost-devel` | NO | C++ libraries |
| OpenSSL | basically any | NO | `libssl-dev` | `openssl` | `openssl-devel` | NO | sha256 sum |
| libzmq | 3.0.0 | NO | `libzmq3-dev` | `zeromq` | `cppzmq-devel` | NO | ZeroMQ library |
| libunbound | 1.4.16 | YES | `libunbound-dev` | `unbound` | `unbound-devel` | NO | DNS resolver |
| libsodium | ? | NO | `libsodium-dev` | ? | `libsodium-devel` | NO | libsodium |
| libminiupnpc | 2.0 | YES | `libminiupnpc-dev` | `miniupnpc` | `miniupnpc-devel` | YES | NAT punching |
| libunwind | any | NO | `libunwind8-dev` | `libunwind` | `libunwind-devel` | YES | Stack traces |
| liblzma | any | NO | `liblzma-dev` | `xz` | `xz-devel` | YES | For libunwind |
| libreadline | 6.3.0 | NO | `libreadline6-dev` | `readline` | `readline-devel` | YES | Input editing |
| ldns | 1.6.17 | NO | `libldns-dev` | `ldns` | `ldns-devel` | YES | SSL toolkit |
| expat | 1.1 | NO | `libexpat1-dev` | `expat` | `expat-devel` | YES | XML parsing |
| GTest | 1.5 | YES | `libgtest-dev` ^ | `gtest` | `gtest-devel` | YES | Test suite |
| Doxygen | any | NO | `doxygen` | `doxygen` | `doxygen` | YES | Documentation |
| Graphviz | any | NO | `graphviz` | `graphviz` | `graphviz` | YES | Documentation |
2016-08-30 01:19:49 +02:00
2017-12-08 04:47:50 +01:00
2016-08-30 01:19:49 +02:00
[^] On Debian/Ubuntu `libgtest-dev` only includes sources and headers. You must
2016-11-12 05:50:24 +01:00
build the library binary manually. This can be done with the following command ```sudo apt-get install libgtest-dev & & cd /usr/src/gtest & & sudo cmake . & & sudo make & & sudo mv libg* /usr/lib/ ```
2016-08-20 07:00:41 +02:00
2018-03-18 18:02:14 +01:00
### Cloning the repository
Clone recursively to pull-in needed submodule(s):
`$ git clone --recursive https://github.com/monero-project/monero`
If you already have a repo cloned, initialize and update:
`$ cd monero && git submodule init && git submodule update`
2017-12-04 20:49:40 +01:00
### Build instructions
2016-08-20 07:00:41 +02:00
2016-08-28 10:15:55 +02:00
Monero uses the CMake build system and a top-level [Makefile ](Makefile ) that
invokes cmake commands as needed.
2014-08-30 08:58:01 +02:00
2016-08-28 10:15:55 +02:00
#### On Linux and OS X
2016-08-20 18:11:57 +02:00
2016-08-28 10:15:55 +02:00
* Install the dependencies
* Change to the root of the source code directory and build:
2016-08-20 18:11:57 +02:00
2016-09-03 21:47:00 +02:00
cd monero
2016-08-28 10:15:55 +02:00
make
2014-08-30 08:58:01 +02:00
2016-08-28 10:15:55 +02:00
*Optional* : If your machine has several cores and enough memory, enable
parallel build by running `make -j<number of threads>` instead of `make` . For
this to be worthwhile, the machine should have one core and about 2GB of RAM
available per thread.
2014-08-30 08:58:01 +02:00
2017-09-20 21:18:50 +02:00
*Note* : If cmake can not find zmq.hpp file on OS X, installing `zmq.hpp` from
https://github.com/zeromq/cppzmq to `/usr/local/include` should fix that error.
2016-10-28 15:51:35 +02:00
* The resulting executables can be found in `build/release/bin`
* Add `PATH="$PATH:$HOME/monero/build/release/bin"` to `.profile`
* Run Monero with `monerod --detach`
2014-08-30 08:58:01 +02:00
2016-08-28 10:15:55 +02:00
* **Optional**: build and run the test suite to verify the binaries:
2015-05-31 12:19:14 +02:00
2016-08-28 10:15:55 +02:00
make release-test
2015-05-31 12:19:14 +02:00
2017-10-19 17:46:17 +02:00
*NOTE* : `core_tests` test may take a few hours to complete.
2015-05-31 12:19:14 +02:00
2016-08-28 10:15:55 +02:00
* **Optional**: to build binaries suitable for debugging:
2015-05-31 12:19:14 +02:00
2016-08-28 10:15:55 +02:00
make debug
2015-05-31 12:19:14 +02:00
2016-08-28 10:15:55 +02:00
* **Optional**: to build statically-linked binaries:
2014-08-30 08:58:01 +02:00
2016-08-28 10:15:55 +02:00
make release-static
2014-08-30 08:58:01 +02:00
2018-04-29 21:05:09 +02:00
Dependencies need to be built with -fPIC. Static libraries usually aren't, so you may have to build them yourself with -fPIC. Refer to their documentation for how to build them.
2016-09-04 04:03:27 +02:00
* **Optional**: build documentation in `doc/html` (omit `HAVE_DOT=YES` if `graphviz` is not installed):
HAVE_DOT=YES doxygen Doxyfile
2017-09-21 00:56:20 +02:00
#### On the Raspberry Pi
2016-10-28 15:51:35 +02:00
2017-09-26 21:00:21 +02:00
Tested on a Raspberry Pi Zero with a clean install of minimal Raspbian Stretch (2017-09-07 or later) from https://www.raspberrypi.org/downloads/raspbian/. If you are using Raspian Jessie, [please see note in the following section ](#note-for-raspbian-jessie-users ).
2016-10-28 15:51:35 +02:00
2016-11-21 23:38:39 +01:00
* `apt-get update && apt-get upgrade` to install all of the latest software
2016-10-28 15:51:35 +02:00
2017-09-21 00:56:20 +02:00
* Install the dependencies for Monero from the 'Debian' column in the table above.
2016-10-28 15:51:35 +02:00
2016-11-21 23:38:39 +01:00
* Increase the system swap size:
```
sudo /etc/init.d/dphys-swapfile stop
sudo nano /etc/dphys-swapfile
CONF_SWAPSIZE=1024
sudo /etc/init.d/dphys-swapfile start
```
2017-09-21 00:56:20 +02:00
* Clone monero and checkout most recent release version:
2016-11-21 23:38:39 +01:00
```
2017-09-21 00:56:20 +02:00
git clone https://github.com/monero-project/monero.git
cd monero
2018-01-20 04:34:14 +01:00
git checkout tags/v0.11.1.0
2016-11-21 23:38:39 +01:00
```
2017-09-21 00:56:20 +02:00
* Build:
2017-04-27 22:11:12 +02:00
```
2016-10-28 15:51:35 +02:00
make release
2017-04-27 22:11:12 +02:00
```
2017-09-21 00:56:20 +02:00
* Wait 4-6 hours
2016-10-28 15:51:35 +02:00
* The resulting executables can be found in `build/release/bin`
* Add `PATH="$PATH:$HOME/monero/build/release/bin"` to `.profile`
* Run Monero with `monerod --detach`
* You may wish to reduce the size of the swap file after the build has finished, and delete the boost directory from your home directory
2016-09-04 04:03:27 +02:00
2017-12-04 20:49:40 +01:00
#### *Note for Raspbian Jessie users:*
2017-09-26 21:00:21 +02:00
If you are using the older Raspbian Jessie image, compiling Monero is a bit more complicated. The version of Boost available in the Debian Jessie repositories is too old to use with Monero, and thus you must compile a newer version yourself. The following explains the extra steps, and has been tested on a Raspberry Pi 2 with a clean install of minimal Raspbian Jessie.
* As before, `apt-get update && apt-get upgrade` to install all of the latest software, and increase the system swap size
```
sudo /etc/init.d/dphys-swapfile stop
sudo nano /etc/dphys-swapfile
CONF_SWAPSIZE=1024
sudo /etc/init.d/dphys-swapfile start
```
* Then, install the dependencies for Monero except `libunwind` and `libboost-all-dev`
2016-11-21 23:38:39 +01:00
* Install the latest version of boost (this may first require invoking `apt-get remove --purge libboost*` to remove a previous version if you're not using a clean install):
```
cd
2017-04-27 22:11:12 +02:00
wget https://sourceforge.net/projects/boost/files/boost/1.64.0/boost_1_64_0.tar.bz2
tar xvfo boost_1_64_0.tar.bz2
cd boost_1_64_0
2016-11-21 23:38:39 +01:00
./bootstrap.sh
sudo ./b2
```
2016-10-28 15:51:35 +02:00
* Wait ~8 hours
2017-04-27 22:11:12 +02:00
```
2016-10-28 15:51:35 +02:00
sudo ./bjam install
2017-04-27 22:11:12 +02:00
```
2016-10-28 15:51:35 +02:00
* Wait ~4 hours
2017-09-26 21:00:21 +02:00
* From here, follow the [general Raspberry Pi instructions ](#on-the-raspberry-pi ) from the "Clone monero and checkout most recent release version" step.
2016-09-04 04:03:27 +02:00
2016-08-28 10:15:55 +02:00
#### On Windows:
2016-01-01 00:05:22 +01:00
2016-08-28 10:15:55 +02:00
Binaries for Windows are built on Windows using the MinGW toolchain within
[MSYS2 environment ](http://msys2.github.io ). The MSYS2 environment emulates a
POSIX system. The toolchain runs within the environment and *cross-compiles*
binaries that can run outside of the environment as a regular Windows
application.
2014-08-30 08:58:01 +02:00
2017-12-04 20:49:40 +01:00
**Preparing the build environment**
2016-01-01 00:05:22 +01:00
2016-08-28 10:15:55 +02:00
* Download and install the [MSYS2 installer ](http://msys2.github.io ), either the 64-bit or the 32-bit package, depending on your system.
* Open the MSYS shell via the `MSYS2 Shell` shortcut
2016-09-26 23:01:51 +02:00
* Update packages using pacman:
2016-09-05 16:54:25 +02:00
pacman -Syuu
* Exit the MSYS shell using Alt+F4
2016-09-05 16:58:45 +02:00
* Edit the properties for the `MSYS2 Shell` shortcut changing "msys2_shell.bat" to "msys2_shell.cmd -mingw64" for 64-bit builds or "msys2_shell.cmd -mingw32" for 32-bit builds
2016-09-05 16:54:25 +02:00
* Restart MSYS shell via modified shortcut and update packages again using pacman:
pacman -Syuu
2014-08-30 08:58:01 +02:00
2016-08-28 10:15:55 +02:00
* Install dependencies:
2016-08-21 18:34:38 +02:00
2016-08-28 10:15:55 +02:00
To build for 64-bit Windows:
2014-08-30 08:58:01 +02:00
2017-09-20 21:18:50 +02:00
pacman -S mingw-w64-x86_64-toolchain make mingw-w64-x86_64-cmake mingw-w64-x86_64-boost mingw-w64-x86_64-openssl mingw-w64-x86_64-zeromq mingw-w64-x86_64-libsodium
2014-09-23 18:15:59 +02:00
2016-08-28 10:15:55 +02:00
To build for 32-bit Windows:
2017-09-20 21:18:50 +02:00
pacman -S mingw-w64-i686-toolchain make mingw-w64-i686-cmake mingw-w64-i686-boost mingw-w64-i686-openssl mingw-w64-i686-zeromq mingw-w64-i686-libsodium
2016-08-28 10:15:55 +02:00
* Open the MingW shell via `MinGW-w64-Win64 Shell` shortcut on 64-bit Windows
or `MinGW-w64-Win64 Shell` shortcut on 32-bit Windows. Note that if you are
running 64-bit Windows, you will have both 64-bit and 32-bit MinGW shells.
2014-09-23 18:15:59 +02:00
2018-05-29 19:20:35 +02:00
**Cloning**
* To git clone, run:
git clone --recursive https://github.com/monero-project/monero.git
2014-09-23 18:18:23 +02:00
**Building**
2014-09-23 18:15:59 +02:00
2018-05-29 19:20:35 +02:00
* Change to the cloned directory, run:
cd monero
* If you would like a specific [version/tag ](https://github.com/monero-project/monero/tags ), do a git checkout for that version. eg. 'v0.12.1.0'. If you dont care about the version and just want binaries from master, skip this step:
git checkout v0.12.1.0
2014-09-23 18:15:59 +02:00
* If you are on a 64-bit system, run:
2016-08-28 10:15:55 +02:00
make release-static-win64
* If you are on a 32-bit system, run:
2014-08-30 08:58:01 +02:00
2016-08-28 10:15:55 +02:00
make release-static-win32
2014-10-06 10:15:22 +02:00
2016-08-28 10:15:55 +02:00
* The resulting executables can be found in `build/release/bin`
2014-10-06 10:15:22 +02:00
2018-05-31 11:40:00 +02:00
* **Optional**: to build Windows binaries suitable for debugging on a 64-bit system, run:
make debug-static-win64
* **Optional**: to build Windows binaries suitable for debugging on a 32-bit system, run:
make debug-static-win32
* The resulting executables can be found in `build/debug/bin`
2014-09-15 12:31:45 +02:00
### On FreeBSD:
2017-03-17 14:29:34 +01:00
The project can be built from scratch by following instructions for Linux above. If you are running monero in a jail you need to add the flag: `allow.sysvipc=1` to your jail configuration, otherwise lmdb will throw the error message: `Failed to open lmdb environment: Function not implemented` .
2014-09-15 12:31:45 +02:00
We expect to add Monero into the ports tree in the near future, which will aid in managing installations using ports or packages.
2016-01-21 19:34:02 +01:00
### On OpenBSD:
2017-10-27 00:15:18 +02:00
#### OpenBSD < 6.2
2016-01-21 19:34:02 +01:00
This has been tested on OpenBSD 5.8.
2016-01-25 01:55:22 +01:00
You will need to add a few packages to your system. `pkg_add db cmake gcc gcc-libs g++ miniupnpc gtest` .
The doxygen and graphviz packages are optional and require the xbase set.
2016-01-21 19:34:02 +01:00
2016-01-21 19:36:25 +01:00
The Boost package has a bug that will prevent librpc.a from building correctly. In order to fix this, you will have to Build boost yourself from scratch. Follow the directions here (under "Building Boost"):
https://github.com/bitcoin/bitcoin/blob/master/doc/build-openbsd.md
2016-01-21 19:37:54 +01:00
2016-01-25 01:55:22 +01:00
You will have to add the serialization, date_time, and regex modules to Boost when building as they are needed by Monero.
2016-01-21 19:34:02 +01:00
2016-01-25 02:00:22 +01:00
To build: `env CC=egcc CXX=eg++ CPP=ecpp DEVELOPER_LOCAL_TOOLS=1 BOOST_ROOT=/path/to/the/boost/you/built make release-static-64`
2016-01-21 19:34:02 +01:00
2017-10-27 00:15:18 +02:00
#### OpenBSD >= 6.2
2018-03-09 22:26:30 +01:00
You will need to add a few packages to your system. `pkg_add cmake miniupnpc zeromq libiconv` .
2017-10-27 00:15:18 +02:00
The doxygen and graphviz packages are optional and require the xbase set.
Build the Boost library using clang. This guide is derived from: https://github.com/bitcoin/bitcoin/blob/master/doc/build-openbsd.md
We assume you are compiling with a non-root user and you have `doas` enabled.
Note: do not use the boost package provided by OpenBSD, as we are installing boost to `/usr/local` .
```
# Create boost building directory
mkdir ~/boost
cd ~/boost
# Fetch boost source
ftp -o boost_1_64_0.tar.bz2 https://netcologne.dl.sourceforge.net/project/boost/boost/1.64.0/boost_1_64_0.tar.bz2
# MUST output: (SHA256) boost_1_64_0.tar.bz2: OK
echo "7bcc5caace97baa948931d712ea5f37038dbb1c5d89b43ad4def4ed7cb683332 boost_1_64_0.tar.bz2" | sha256 -c
tar xfj boost_1_64_0.tar.bz2
2018-03-09 22:26:30 +01:00
# Fetch and apply boost patches, required for OpenBSD
ftp -o boost_test_impl_execution_monitor_ipp.patch https://raw.githubusercontent.com/openbsd/ports/bee9e6df517077a7269ff0dfd57995f5c6a10379/devel/boost/patches/patch-boost_test_impl_execution_monitor_ipp
ftp -o boost_config_platform_bsd_hpp.patch https://raw.githubusercontent.com/openbsd/ports/90658284fb786f5a60dd9d6e8d14500c167bdaa0/devel/boost/patches/patch-boost_config_platform_bsd_hpp
# MUST output: (SHA256) boost_config_platform_bsd_hpp.patch: OK
echo "1f5e59d1154f16ee1e0cc169395f30d5e7d22a5bd9f86358f738b0ccaea5e51d boost_config_platform_bsd_hpp.patch" | sha256 -c
# MUST output: (SHA256) boost_test_impl_execution_monitor_ipp.patch: OK
echo "30cec182a1437d40c3e0bd9a866ab5ddc1400a56185b7e671bb3782634ed0206 boost_test_impl_execution_monitor_ipp.patch" | sha256 -c
2017-10-27 00:15:18 +02:00
cd boost_1_64_0
2018-03-09 22:26:30 +01:00
patch -p0 < .. / boost_test_impl_execution_monitor_ipp . patch
patch -p0 < .. / boost_config_platform_bsd_hpp . patch
2017-10-27 00:15:18 +02:00
# Start building boost
echo 'using clang : : c++ : < cxxflags > "-fvisibility=hidden -fPIC" < linkflags > "" < archiver > "ar" < striper > "strip" < ranlib > "ranlib" < rc > "" : ;' > user-config.jam
2018-03-09 22:26:30 +01:00
./bootstrap.sh --without-icu --with-libraries=chrono,filesystem,program_options,system,thread,test,date_time,regex,serialization,locale --with-toolset=clang
./b2 toolset=clang cxxflags="-stdlib=libc++" linkflags="-stdlib=libc++" -sICONV_PATH=/usr/local
doas ./b2 -d0 runtime-link=shared threadapi=pthread threading=multi link=static variant=release --layout=tagged --build-type=complete --user-config=user-config.jam -sNO_BZIP2=1 -sICONV_PATH=/usr/local --prefix=/usr/local install
2017-10-27 00:15:18 +02:00
```
Build cppzmq
Build the cppzmq bindings.
We assume you are compiling with a non-root user and you have `doas` enabled.
```
# Create cppzmq building directory
mkdir ~/cppzmq
cd ~/cppzmq
# Fetch cppzmq source
2018-03-09 22:26:30 +01:00
ftp -o cppzmq-4.2.3.tar.gz https://github.com/zeromq/cppzmq/archive/v4.2.3.tar.gz
2017-10-27 00:15:18 +02:00
2018-03-09 22:26:30 +01:00
# MUST output: (SHA256) cppzmq-4.2.3.tar.gz: OK
echo "3e6b57bf49115f4ae893b1ff7848ead7267013087dc7be1ab27636a97144d373 cppzmq-4.2.3.tar.gz" | sha256 -c
tar xfz cppzmq-4.2.3.tar.gz
2017-10-27 00:15:18 +02:00
# Start building cppzmq
2018-03-09 22:26:30 +01:00
cd cppzmq-4.2.3
2017-10-27 00:15:18 +02:00
mkdir build
cd build
cmake ..
doas make install
```
Build monero: `env DEVELOPER_LOCAL_TOOLS=1 BOOST_ROOT=/usr/local make release-static`
2017-10-10 15:05:28 +02:00
### On Solaris:
The default Solaris linker can't be used, you have to install GNU ld, then run cmake manually with the path to your copy of GNU ld:
mkdir -p build/release
cd build/release
cmake -DCMAKE_LINKER=/path/to/ld -D CMAKE_BUILD_TYPE=Release ../..
cd ../..
Then you can run make as usual.
2017-07-13 03:28:56 +02:00
### On Linux for Android (using docker):
# Build image (select android64.Dockerfile for aarch64)
cd utils/build_scripts/ & & docker build -f android32.Dockerfile -t monero-android .
# Create container
docker create -it --name monero-android monero-android bash
# Get binaries
docker cp monero-android:/opt/android/monero/build/release/bin .
2017-12-04 20:49:40 +01:00
### Building portable statically linked binaries
2016-08-28 10:15:55 +02:00
By default, in either dynamically or statically linked builds, binaries target the specific host processor on which the build happens and are not portable to other processors. Portable binaries can be built using the following targets:
2017-09-25 19:04:03 +02:00
* ```make release-static-linux-x86_64``` builds binaries on Linux on x86_64 portable across POSIX systems on x86_64 processors
* ```make release-static-linux-i686``` builds binaries on Linux on x86_64 or i686 portable across POSIX systems on i686 processors
* ```make release-static-linux-armv8``` builds binaries on Linux portable across POSIX systems on armv8 processors
* ```make release-static-linux-armv7``` builds binaries on Linux portable across POSIX systems on armv7 processors
* ```make release-static-linux-armv6``` builds binaries on Linux portable across POSIX systems on armv6 processors
2016-08-28 10:15:55 +02:00
* ```make release-static-win64``` builds binaries on 64-bit Windows portable across 64-bit Windows systems
* ```make release-static-win32``` builds binaries on 64-bit or 32-bit Windows portable across 32-bit Windows systems
2018-05-10 03:48:19 +02:00
## Installing Monero from a package
**DISCLAIMER: These packages are not part of this repository or maintained by this project's contributors, and as such, do not go through the same review process to ensure their trustworthiness and security.**
Packages are available for
* Ubuntu and [snap supported ](https://snapcraft.io/docs/core/install ) systems, via a community contributed build.
snap install monero --beta
Installing a snap is very quick. Snaps are secure. They are isolated with all of their dependencies. Snaps also auto update when a new version is released.
* Arch Linux (via [AUR ](https://aur.archlinux.org/ )):
- Stable release: [`monero` ](https://aur.archlinux.org/packages/monero )
- Bleeding edge: [`monero-git` ](https://aur.archlinux.org/packages/monero-git )
* Void Linux:
xbps-install -S monero
* GuixSD
guix package -i monero
* Docker
# Build using all available cores
docker build -t monero .
# or build using a specific number of cores (reduce RAM requirement)
docker build --build-arg NPROC=1 -t monero .
# either run in foreground
docker run -it -v /monero/chain:/root/.bitmonero -v /monero/wallet:/wallet -p 18080:18080 monero
# or in background
docker run -it -d -v /monero/chain:/root/.bitmonero -v /monero/wallet:/wallet -p 18080:18080 monero
Packaging for your favorite distribution would be a welcome contribution!
2016-09-03 21:47:00 +02:00
## Running monerod
2016-05-28 22:41:00 +02:00
The build places the binary in `bin/` sub-directory within the build directory
from which cmake was invoked (repository root by default). To run in
foreground:
2016-09-03 21:47:00 +02:00
./bin/monerod
2016-05-28 22:41:00 +02:00
2016-09-03 21:47:00 +02:00
To list all available options, run `./bin/monerod --help` . Options can be
2016-05-28 22:41:00 +02:00
specified either on the command line or in a configuration file passed by the
`--config-file` argument. To specify an option in the configuration file, add
a line with the syntax `argumentname=value` , where `argumentname` is the name
2016-08-20 06:49:10 +02:00
of the argument without the leading dashes, for example `log-level=1` .
2016-05-28 22:41:00 +02:00
2016-08-25 05:05:30 +02:00
To run in background:
2016-09-03 21:47:00 +02:00
./bin/monerod --log-file monerod.log --detach
2016-08-25 05:05:30 +02:00
To run as a systemd service, copy
2016-09-03 21:47:00 +02:00
[monerod.service ](utils/systemd/monerod.service ) to `/etc/systemd/system/` and
[monerod.conf ](utils/conf/monerod.conf ) to `/etc/` . The [example
service](utils/systemd/monerod.service) assumes that the user `monero` exists
2016-08-25 05:05:30 +02:00
and its home is the data directory specified in the [example
2016-09-03 21:47:00 +02:00
config](utils/conf/monerod.conf).
2016-08-25 05:05:30 +02:00
2016-09-18 11:23:02 +02:00
If you're on Mac, you may need to add the `--max-concurrency 1` option to
monero-wallet-cli, and possibly monerod, if you get crashes refreshing.
2015-07-14 21:28:25 +02:00
## Internationalization
2017-06-04 13:44:45 +02:00
See [README.i18n.md ](README.i18n.md ).
2015-07-14 21:28:25 +02:00
2015-12-14 23:47:19 +01:00
## Using Tor
2018-03-10 17:32:55 +01:00
While Monero isn't made to integrate with Tor, it can be used wrapped with torsocks, by
setting the following configuration parameters and environment variables:
* `--p2p-bind-ip 127.0.0.1` on the command line or `p2p-bind-ip=127.0.0.1` in
monerod.conf to disable listening for connections on external interfaces.
* `--no-igd` on the command line or `no-igd=1` in monerod.conf to disable IGD
(UPnP port forwarding negotiation), which is pointless with Tor.
* `DNS_PUBLIC=tcp` or `DNS_PUBLIC=tcp://x.x.x.x` where x.x.x.x is the IP of the
desired DNS server, for DNS requests to go over TCP, so that they are routed
through Tor. When IP is not specified, monerod uses the default list of
servers defined in [src/common/dns_utils.cpp ](src/common/dns_utils.cpp ).
* `TORSOCKS_ALLOW_INBOUND=1` to tell torsocks to allow monerod to bind to interfaces
to accept connections from the wallet. On some Linux systems, torsocks
allows binding to localhost by default, so setting this variable is only
necessary to allow binding to local LAN/VPN interfaces to allow wallets to
connect from remote hosts. On other systems, it may be needed for local wallets
as well.
* Do NOT pass `--detach` when running through torsocks with systemd, (see
[utils/systemd/monerod.service ](utils/systemd/monerod.service ) for details).
Example command line to start monerod through Tor:
DNS_PUBLIC=tcp torsocks monerod --p2p-bind-ip 127.0.0.1 --no-igd
### Using Tor on Tails
TAILS ships with a very restrictive set of firewall rules. Therefore, you need
to add a rule to allow this connection too, in addition to telling torsocks to
allow inbound connections. Full example:
sudo iptables -I OUTPUT 2 -p tcp -d 127.0.0.1 -m tcp --dport 18081 -j ACCEPT
DNS_PUBLIC=tcp torsocks ./monerod --p2p-bind-ip 127.0.0.1 --no-igd --rpc-bind-ip 127.0.0.1 \
--data-dir /home/amnesia/Persistent/your/directory/to/the/blockchain
2015-12-14 23:47:19 +01:00
2017-12-05 02:47:39 +01:00
## Debugging
2016-11-22 00:00:20 +01:00
2017-12-05 02:47:39 +01:00
This section contains general instructions for debugging failed installs or problems encountered with Monero. First ensure you are running the latest version built from the Github repo.
2016-11-22 00:00:20 +01:00
2017-12-05 02:47:39 +01:00
### Obtaining stack traces and core dumps on Unix systems
2017-01-22 16:45:14 +01:00
We generally use the tool `gdb` (GNU debugger) to provide stack trace functionality, and `ulimit` to provide core dumps in builds which crash or segfault.
* To use gdb in order to obtain a stack trace for a build that has stalled:
Run the build.
Once it stalls, enter the following command:
```
gdb /path/to/monerod `pidof monerod`
```
Type `thread apply all bt` within gdb in order to obtain the stack trace
* If however the core dumps or segfaults:
Enter `ulimit -c unlimited` on the command line to enable unlimited filesizes for core dumps
2017-09-08 19:41:27 +02:00
Enter `echo core | sudo tee /proc/sys/kernel/core_pattern` to stop cores from being hijacked by other tools
2017-01-22 16:45:14 +01:00
Run the build.
2017-09-08 19:41:27 +02:00
When it terminates with an output along the lines of "Segmentation fault (core dumped)", there should be a core dump file in the same directory as monerod. It may be named just `core` , or `core.xxxx` with numbers appended.
2017-01-22 16:45:14 +01:00
You can now analyse this core dump with `gdb` as follows:
`gdb /path/to/monerod /path/to/dumpfile`
Print the stack trace with `bt`
* To run monero within gdb:
Type `gdb /path/to/monerod`
Pass command-line options with `--args` followed by the relevant arguments
Type `run` to run monerod
2017-12-05 02:47:39 +01:00
### Analysing memory corruption
2017-01-22 16:45:14 +01:00
We use the tool `valgrind` for this.
Run with `valgrind /path/to/monerod` . It will be slow.
2017-12-05 02:47:39 +01:00
### LMDB
2016-11-22 00:00:20 +01:00
Instructions for debugging suspected blockchain corruption as per @HYC
There is an `mdb_stat` command in the LMDB source that can print statistics about the database but it's not routinely built. This can be built with the following command:
`cd ~/monero/external/db_drivers/liblmdb && make`
The output of `mdb_stat -ea <path to blockchain dir>` will indicate inconsistencies in the blocks, block_heights and block_info table.
The output of `mdb_dump -s blocks <path to blockchain dir>` and `mdb_dump -s block_info <path to blockchain dir>` is useful for indicating whether blocks and block_info contain the same keys.
These records are dumped as hex data, where the first line is the key and the second line is the data.
