Docs4Doge installation : reorganize unix build instructions

Author: AbcSxyZ <[email protected]>
Cherry-picked from:
23c735353 build-unix: fix FreeBSD dependencies overwritten by Fedora
1818c33a5 docs4doge: rewrite unix build instructions
0b41d5552 Docs4Doge installation : reorganize unix build instructions

1 files changed, 118 insertions, 164 deletions

diff --git a/doc/build-unix.md b/doc/build-unix.md
index 13ae8dbcc..4370d1efe 100644
--- a/doc/build-unix.md
+++ b/doc/build-unix.md
@@ -1,35 +1,26 @@
-UNIX BUILD NOTES
-====================
-Some notes on how to build Dogecoin Core in Unix.
+# Unix Build of Dogecoin Core
 
-(for OpenBSD specific instructions, see [build-openbsd.md](build-openbsd.md))
+1. [Install dependencies](#install-dependencies)
+    * [Ubuntu & Debian](#ubuntu--debian)
+    * [Fedora](#Fedora)
+    * [FreeBSD](#FreeBSD)
+2. [Build steps](#build-steps)
+3. [Build configuration](#build-configuration)
+    * [Enable Qt GUI](#enable-qt-gui)
+    * [Wallet](#wallet)
+    * [Disable-wallet mode](#disable-wallet-mode)
+    * [Miniupnpc](#miniupnpc)
+    * [Security](#security)
+    * [Memory requirements](#memory-requirements)
+4. [ARM Cross-compilation](#arm-cross-compilation)
 
-Note
----------------------
-Always use absolute paths to configure and compile Dogecoin and the dependencies,
-for example, when specifying the path of the dependency:
+## Install dependencies
 
-	../dist/configure --enable-cxx --disable-shared --with-pic --prefix=$BDB_PREFIX
+You must install required dependencies to build a basic Dogecoin daemon, optional dependencies may vary according to your requirements.
 
-Here BDB_PREFIX must be an absolute path - it is defined using $(pwd) which ensures
-the usage of the absolute path.
+Wallet is optional to run a node, see [Wallet](#wallet) section to enable them.
 
-To Build
----------------------
-
-```bash
-./autogen.sh
-./configure
-make
-make install # optional
-```
-
-This will build Dogecoin-Qt as well if the dependencies are met.
-
-Dependencies
----------------------
-
-These dependencies are required:
+**Required dependencies :**
 
  Library     | Purpose          | Description
  ------------|------------------|----------------------
@@ -37,7 +28,7 @@ These dependencies are required:
  libboost    | Utility          | Library for threading, data structures, etc
  libevent    | Networking       | OS independent asynchronous networking
 
-Optional dependencies:
+**Optional dependencies:**
 
  Library     | Purpose          | Description
  ------------|------------------|----------------------
@@ -51,147 +42,120 @@ Optional dependencies:
 
 For the versions used in the release, see [release-process.md](release-process.md) under *Fetch and build inputs*.
 
-Memory Requirements
---------------------
 
-C++ compilers are memory-hungry. It is recommended to have at least 1.5 GB of
-memory available when compiling Dogecoin Core. On systems with less, gcc can be
-tuned to conserve memory with additional CXXFLAGS:
+### Ubuntu & Debian
 
-    ./configure CXXFLAGS="--param ggc-min-expand=1 --param ggc-min-heapsize=32768"
-
-Dependency Build Instructions: Ubuntu & Debian
-----------------------------------------------
-Build requirements:
-
-    sudo apt-get install build-essential libtool autotools-dev automake pkg-config libssl-dev libevent-dev bsdmainutils
-
-Options when installing required Boost library files:
-
-1. On at least Ubuntu 14.04+ and Debian 7+ there are generic names for the
-individual boost development packages, so the following can be used to only
-install necessary parts of boost:
-
-        sudo apt-get install libboost-system-dev libboost-filesystem-dev libboost-chrono-dev libboost-program-options-dev libboost-test-dev libboost-thread-dev
+**Required dependencies** :
+```bash
+sudo apt-get install build-essential libtool autotools-dev automake pkg-config libssl-dev libevent-dev bsdmainutils
+sudo apt-get install libboost-system-dev libboost-filesystem-dev libboost-chrono-dev libboost-program-options-dev libboost-test-dev libboost-thread-dev
+```
 
-2. If that doesn't work, you can install all boost development packages with:
+**Optional dependencies** :  
+```bash
+# Qt (required for dogecoin-qt GUI)
+sudo apt-get install libqt5gui5 libqt5core5a libqt5dbus5 qttools5-dev qttools5-dev-tools libprotobuf-dev protobuf-compiler libqrencode-dev
 
-        sudo apt-get install libboost-all-dev
+# BerkeleyDB (version 5.3)
+sudo apt install libdb5.3++-dev libdb5.3++ libdb5.3-dev
 
-BerkeleyDB is required for the wallet.
+# ZMQ (provides ZMQ API 4.x)
+sudo apt-get install libzmq3-dev
 
-    sudo apt-get install libdb5.1-dev libdb5.1++-dev
+# Miniupnpc
+sudo apt-get install libminiupnpc-dev
+```
 
-       Note that if you have Berkeley DB 4.8 packages installed (i.e. for other
-       wallet software), they are incompatible with the packages for 5.1. You
-       will have to manually download 5.1 from
-       http://download.oracle.com/berkeley-db/db-5.1.29.NC.tar.gz and compile
-       it, install it to /usr/local where the configure script should locate it
-       automatically.
+## Build steps
 
+According to installed dependencies, the following steps will compile `dogecoind`, `dogecoin-cli` and `dogecoin-qt`.
 
-See the section "Disable-wallet mode" to build Dogecoin Core without wallet.
+```bash
+./autogen.sh
+./configure
+make
+make install # optional
+```
+See [Build configuration](#build-configuration) for extra settings.
 
-Optional (see --with-miniupnpc and --enable-upnp-default):
+## Build configuration
 
-    sudo apt-get install libminiupnpc-dev
+Configurations are done during the `./configure` step. Use `--help` to see all available options.
 
-ZMQ dependencies (provides ZMQ API 4.x):
+#### Enable Qt GUI
+Create `dogecoin-qt`, the core wallet GUI.
+```bash
+./configure --with-gui
+```
 
-    sudo apt-get install libzmq3-dev
+#### Wallet
+BerkeleyDB is required for wallet functionality and use the `wallet.dat` file.
 
-Dependencies for the GUI: Ubuntu & Debian
------------------------------------------
+By default, **Dogecoin Core expect BerkeleyDB 5.1**.  
+You can use a different version by specifying `--with-incompatible-bdb` flag.
 
-If you want to build Dogecoin-Qt, make sure that the required packages for Qt development
-are installed. Either Qt 5 or Qt 4 are necessary to build the GUI.
-If both Qt 4 and Qt 5 are installed, Qt 5 will be used. Pass `--with-gui=qt4` to configure to choose Qt4.
-To build without GUI pass `--without-gui`.
+If no package is available for your distribution  in optional dependencies, you can build BerkeleyDB from source :
+```bash
+# Install script for BerkeleyDB 5.1
 
-To build with Qt 5 (recommended) you need the following:
+# BerkeleyDB installation directory
+BDB_PREFIX=$(pwd)/bdb
+mkdir $BDB_PREFIX
 
-    sudo apt-get install libqt5gui5 libqt5core5a libqt5dbus5 qttools5-dev qttools5-dev-tools libprotobuf-dev protobuf-compiler
+# Fetch the source and verify shasum
+wget 'http://download.oracle.com/berkeley-db/db-5.1.29.NC.tar.gz'
+echo '08238e59736d1aacdd47cfb8e68684c695516c37f4fbe1b8267dde58dc3a576c db-5.1.29.NC.tar.gz' | sha256sum -c
 
-Alternatively, to build with Qt 4 you need the following:
+# Extract sources
+tar -xzvf db-5.1.29.NC.tar.gz
+cd db-5.1.29.NC/build_unix/
 
-    sudo apt-get install libqt4-dev libprotobuf-dev protobuf-compiler
+# Apply patch (see https://gist.github.com/danieldk/5700533)
+sed -i  's/__atomic_compare_exchange/__atomic_compare_exchange_db/g' ../src/dbinc/atomic.h
 
-libqrencode (optional) can be installed with:
+# Note: Do a static build so that it can be embedded into the executable, instead of having to find a .so at runtime
+../dist/configure --prefix=$BDB_PREFIX --enable-cxx --disable-shared --with-pic
+make install
+```
 
-    sudo apt-get install libqrencode-dev
+Then use `LDFLAGS` and `CPPFLAGS` during configuration to link the database :
+```bash
+./configure  LDFLAGS="-L${BDB_PREFIX}/lib/" CPPFLAGS="-I${BDB_PREFIX}/include/"
+```
 
-Once these are installed, they will be found by configure and a dogecoin-qt executable will be
-built by default.
+#### Disable-wallet mode
+When the intention is to run only a P2P node without a wallet, Dogecoin may be compiled in
+disable-wallet mode with:
 
-Notes
------
-The release is built with GCC and then "strip dogecoind" to strip the debug
-symbols, which reduces the executable size by about 90%.
+```bash
+./configure --disable-wallet
+```
 
+Mining is also possible in disable-wallet mode, but only using the `getblocktemplate` RPC
+call, not `getwork`.
 
-miniupnpc
----------
+#### Miniupnpc
 
 [miniupnpc](http://miniupnp.free.fr/) may be used for UPnP port mapping.  It can be downloaded from [here](
 http://miniupnp.tuxfamily.org/files/).  UPnP support is compiled in and
 turned off by default.  See the configure options for upnp behavior desired:
 
-	--without-miniupnpc      No UPnP support miniupnp not required
-	--disable-upnp-default   (the default) UPnP support turned off by default at runtime
-	--enable-upnp-default    UPnP support turned on by default at runtime
-
-
-Berkeley DB
------------
-It is recommended to use Berkeley DB 5.1. If you have to build it yourself:
-
 ```bash
-BITCOIN_ROOT=$(pwd)
-
-# Pick some path to install BDB to, here we create a directory within the dogecoin directory
-BDB_PREFIX="${BITCOIN_ROOT}/db5"
-mkdir -p $BDB_PREFIX
-
-# Fetch the source and verify that it is not tampered with
-wget 'http://download.oracle.com/berkeley-db/db-5.1.29.NC.tar.gz'
-echo '08238e59736d1aacdd47cfb8e68684c695516c37f4fbe1b8267dde58dc3a576c db-5.1.29.NC.tar.gz' | sha256sum -c
-# -> db-5.1.29.NC.tar.gz: OK
-tar -xzvf db-5.1.29.NC.tar.gz
-
-# Build the library and install to our prefix
-cd db-5.1.29.NC/build_unix/
-#  Note: Do a static build so that it can be embedded into the executable, instead of having to find a .so at runtime
-../dist/configure --enable-cxx --disable-shared --with-pic --prefix=$BDB_PREFIX
-make install
-
-# Configure Dogecoin Core to use our own-built instance of BDB
-cd $BITCOIN_ROOT
-./autogen.sh
-./configure LDFLAGS="-L${BDB_PREFIX}/lib/" CPPFLAGS="-I${BDB_PREFIX}/include/" # (other args...)
+--without-miniupnpc      #No UPnP support miniupnp not required
+--disable-upnp-default   #(the default) UPnP support turned off by default at runtime
+--enable-upnp-default    #UPnP support turned on by default at runtime
 ```
 
-**Note**: You only need Berkeley DB if the wallet is enabled (see the section *Disable-Wallet mode* below).
-
-Boost
------
-If you need to build Boost yourself:
-
-	sudo su
-	./bootstrap.sh
-	./bjam install
-
-
-Security
---------
+#### Security
 To help make your Dogecoin installation more secure by making certain attacks impossible to
 exploit even if a vulnerability is found, binaries are hardened by default.
 This can be disabled with:
 
 Hardening Flags:
-
-	./configure --enable-hardening
-	./configure --disable-hardening
-
+```bash
+./configure --enable-hardening
+./configure --disable-hardening
+```
 
 Hardening enables the following features:
 
@@ -203,16 +167,15 @@ Hardening enables the following features:
     randomly located as well.
 
     On an AMD64 processor where a library was not compiled with -fPIC, this will cause an error
-    such as: "relocation R_X86_64_32 against `......' can not be used when making a shared object;"
+    such as: `relocation R_X86_64_32 against '......' can not be used when making a shared object;`
 
     To test that you have built PIE executable, install scanelf, part of paxutils, and use:
 
-	scanelf -e ./dogecoin
+	`scanelf -e ./dogecoin`
 
     The output should contain:
 
-     TYPE
-    ET_DYN
+    `TYPE ET_DYN`
 
 * Non-executable Stack
     If the stack is executable, trivial stack-based buffer overflow exploits are possible if
@@ -225,48 +188,39 @@ Hardening enables the following features:
     `scanelf -e ./dogecoin`
 
     the output should contain:
-	STK/REL/PTL
-	RW- R-- RW-
-
-    The STK RW- means that the stack is readable and writeable, but not executable.
-
-Disable-wallet mode
---------------------
-When the intention is to run only a P2P node without a wallet, Dogecoin may be compiled in
-disable-wallet mode with:
+    `STK/REL/PTL RW- R-- RW-`
 
-    ./configure --disable-wallet
+    The `STK RW-` means that the stack is readable and writeable, but not executable.
 
-In this case there is no dependency on Berkeley DB 4.8.
 
-Mining is also possible in disable-wallet mode, but only using the `getblocktemplate` RPC
-call, not `getwork`.
+#### Memory Requirements
 
-Additional Configure Flags
---------------------------
-A list of additional configure flags can be displayed with:
+C++ compilers are memory-hungry. It is recommended to have at
+least 1.5 GB of memory available when compiling Dogecoin Core.
+On systems with less, gcc can be tuned to conserve memory with additional CXXFLAGS:
 
-    ./configure --help
+```bash
+./configure CXXFLAGS="--param ggc-min-expand=1 --param ggc-min-heapsize=32768"
+```
 
+## ARM Cross-compilation
 
-ARM Cross-compilation
--------------------
 These steps can be performed on, for example, an Ubuntu VM. The depends system
 will also work on other Linux distributions, however the commands for
 installing the toolchain will be different.
 
 Make sure you install the build requirements mentioned above.
 Then, install the toolchain and curl:
-
-    sudo apt-get install g++-arm-linux-gnueabihf curl
+```bash
+sudo apt-get install g++-arm-linux-gnueabihf curl
+```
 
 To build executables for ARM:
-
-    cd depends
-    make HOST=arm-linux-gnueabihf NO_QT=1
-    cd ..
-    ./configure --prefix=$PWD/depends/arm-linux-gnueabihf --enable-glibc-back-compat --enable-reduce-exports LDFLAGS=-static-libstdc++
-    make
-
-
+```bash
+cd depends
+make HOST=arm-linux-gnueabihf NO_QT=1
+cd ..
+./configure --prefix=$PWD/depends/arm-linux-gnueabihf --enable-glibc-back-compat --enable-reduce-exports LDFLAGS=-static-libstdc++
+make
+```
 For further documentation on the depends system see [README.md](../depends/README.md) in the depends directory.