doc/build-osx.md

   1 Mac OS X Build Instructions and Notes
   2 ====================================
   3 This guide will show you how to build bitcoind(headless client) for OSX.
   4
   5 Notes
   6 -----
   7
   8 * Tested on OS X 10.6 through 10.9 on 64-bit Intel processors only.
   9 Older OSX releases or 32-bit processors are no longer supported.
  10
  11 * All of the commands should be executed in a Terminal application. The
  12 built-in one is located in `/Applications/Utilities`.
  13
  14 Preparation
  15 -----------
  16
  17 You need to install XCode with all the options checked so that the compiler
  18 and everything is available in /usr not just /Developer. XCode should be
  19 available on your OS X installation media, but if not, you can get the
  20 current version from https://developer.apple.com/xcode/. If you install
  21 Xcode 4.3 or later, you'll need to install its command line tools. This can
  22 be done in `Xcode > Preferences > Downloads > Components` and generally must
  23 be re-done or updated every time Xcode is updated.
  24
  25 There's also an assumption that you already have `git` installed. If
  26 not, it's the path of least resistance to install [Github for Mac](https://mac.github.com/)
  27 (OS X 10.7+) or
  28 [Git for OS X](https://code.google.com/p/git-osx-installer/). It is also
  29 available via Homebrew or MacPorts.
  30
  31 You will also need to install [Homebrew](http://brew.sh)
  32 or [MacPorts](https://www.macports.org/) in order to install library
  33 dependencies. It's largely a religious decision which to choose, however, Homebrew
  34 is now used for building release versions.
  35
  36 The installation of the actual dependencies is covered in the Instructions
  37 sections below.
  38
  39 Instructions: MacPorts
  40 ----------------------
  41
  42 ### Install dependencies
  43
  44     sudo port install boost db48@+no_java openssl miniupnpc autoconf pkgconfig automake libtool
  45
  46 Optional: install Qt4
  47
  48     sudo port install qt4-mac qrencode protobuf-cpp
  49
  50 ### Building `bitcoind`
  51
  52 1. Clone the github tree to get the source code and go into the directory.
  53
  54         git clone git@github.com:bitcoin/bitcoin.git bitcoin
  55         cd bitcoin
  56
  57 2.  Build bitcoind (and Bitcoin-Qt, if configured):
  58
  59         ./autogen.sh
  60         ./configure
  61         make
  62
  63 3.  It is a good idea to build and run the unit tests, too:
  64
  65         make check
  66
  67 Instructions: Homebrew
  68 ----------------------
  69
  70 #### Install dependencies using Homebrew
  71
  72         brew install autoconf automake libtool boost miniupnpc openssl pkg-config protobuf qt
  73
  74 #### Installing berkeley-db4 using Homebrew
  75
  76 The homebrew package for berkeley-db4 has been broken for some time.  It will install without Java though.
  77
  78 Running this command takes you into brew's interactive mode, which allows you to configure, make, and install by hand:
  79 ```
  80 $ brew install https://raw.github.com/mxcl/homebrew/master/Library/Formula/berkeley-db4.rb -–without-java
  81 ```
  82
  83 These rest of these commands are run inside brew interactive mode:
  84 ```
  85 /private/tmp/berkeley-db4-UGpd0O/db-4.8.30 $ cd ..
  86 /private/tmp/berkeley-db4-UGpd0O $ db-4.8.30/dist/configure --prefix=/usr/local/Cellar/berkeley-db4/4.8.30 --mandir=/usr/local/Cellar/berkeley-db4/4.8.30/share/man --enable-cxx
  87 /private/tmp/berkeley-db4-UGpd0O $ make
  88 /private/tmp/berkeley-db4-UGpd0O $ make install
  89 /private/tmp/berkeley-db4-UGpd0O $ exit
  90 ```
  91
  92 After exiting, you'll get a warning that the install is keg-only, which means it wasn't symlinked to `/usr/local`.  You don't need it to link it to build bitcoin, but if you want to, here's how:
  93
  94     $ brew --force link berkeley-db4
  95
  96
  97 ### Building `bitcoind`
  98
  99 1. Clone the github tree to get the source code and go into the directory.
 100
 101         git clone https://github.com/bitcoin/bitcoin.git
 102         cd bitcoin
 103
 104 2.  Build bitcoind:
 105
 106         ./autogen.sh
 107         ./configure
 108         make
 109
 110 3.  It is also a good idea to build and run the unit tests:
 111
 112         make check
 113
 114 Creating a release build
 115 ------------------------
 116 You can ignore this section if you are building `bitcoind` for your own use.
 117
 118 bitcoind/bitcoin-cli binaries are not included in the Bitcoin-Qt.app bundle.
 119
 120 If you are building `bitcoind` or `Bitcoin-Qt` for others, your build machine should be set up
 121 as follows for maximum compatibility:
 122
 123 All dependencies should be compiled with these flags:
 124
 125  -mmacosx-version-min=10.6
 126  -arch x86_64
 127  -isysroot $(xcode-select --print-path)/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.6.sdk
 128
 129 For MacPorts, that means editing your macports.conf and setting
 130 `macosx_deployment_target` and `build_arch`:
 131
 132     macosx_deployment_target=10.6
 133     build_arch=x86_64
 134
 135 ... and then uninstalling and re-installing, or simply rebuilding, all ports.
 136
 137 As of December 2012, the `boost` port does not obey `macosx_deployment_target`.
 138 Download `https://gavinandresen-bitcoin.s3.amazonaws.com/boost_macports_fix.zip`
 139 for a fix.
 140
 141 Once dependencies are compiled, see release-process.md for how the Bitcoin-Qt.app
 142 bundle is packaged and signed to create the .dmg disk image that is distributed.
 143
 144 Running
 145 -------
 146
 147 It's now available at `./bitcoind`, provided that you are still in the `src`
 148 directory. We have to first create the RPC configuration file, though.
 149
 150 Run `./bitcoind` to get the filename where it should be put, or just try these
 151 commands:
 152
 153     echo -e "rpcuser=bitcoinrpc\nrpcpassword=$(xxd -l 16 -p /dev/urandom)" > "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf"
 154     chmod 600 "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf"
 155
 156 The next time you run it, it will start downloading the blockchain, but it won't
 157 output anything while it's doing this. This process may take several hours;
 158 you can monitor its process by looking at the debug.log file, like this:
 159
 160     tail -f $HOME/Library/Application\ Support/Bitcoin/debug.log
 161
 162 Other commands:
 163 -------
 164
 165     ./bitcoind -daemon # to start the bitcoin daemon.
 166     ./bitcoin-cli --help  # for a list of command-line options.
 167     ./bitcoin-cli help    # When the daemon is running, to get a list of RPC commands