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.
  30
  31 You will also need to install [Homebrew](http://brew.sh) in order to install library
  32 dependencies.
  33
  34 The installation of the actual dependencies is covered in the Instructions
  35 sections below.
  36
  37 Instructions: Homebrew
  38 ----------------------
  39
  40 #### Install dependencies using Homebrew
  41
  42         brew install autoconf automake libtool boost miniupnpc openssl pkg-config protobuf qt
  43
  44 #### Installing berkeley-db4 using Homebrew
  45
  46 The homebrew package for berkeley-db4 has been broken for some time.  It will install without Java though.
  47
  48 Running this command takes you into brew's interactive mode, which allows you to configure, make, and install by hand:
  49 ```
  50 $ brew install https://raw.github.com/mxcl/homebrew/master/Library/Formula/berkeley-db4.rb -–without-java
  51 ```
  52
  53 The rest of these commands are run inside brew interactive mode:
  54 ```
  55 /private/tmp/berkeley-db4-UGpd0O/db-4.8.30 $ cd ..
  56 /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
  57 /private/tmp/berkeley-db4-UGpd0O $ make
  58 /private/tmp/berkeley-db4-UGpd0O $ make install
  59 /private/tmp/berkeley-db4-UGpd0O $ exit
  60 ```
  61
  62 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:
  63
  64     $ brew link --force berkeley-db4
  65
  66
  67 ### Building `bitcoind`
  68
  69 1. Clone the github tree to get the source code and go into the directory.
  70
  71         git clone https://github.com/bitcoin/bitcoin.git
  72         cd bitcoin
  73
  74 2.  Build bitcoind:
  75
  76         ./autogen.sh
  77         ./configure
  78         make
  79
  80 3.  It is also a good idea to build and run the unit tests:
  81
  82         make check
  83
  84 4.  (Optional) You can also install bitcoind to your path:
  85
  86         make install
  87
  88 Creating a release build
  89 ------------------------
  90 You can ignore this section if you are building `bitcoind` for your own use.
  91
  92 bitcoind/bitcoin-cli binaries are not included in the Bitcoin-Qt.app bundle.
  93
  94 If you are building `bitcoind` or `Bitcoin-Qt` for others, your build machine should be set up
  95 as follows for maximum compatibility:
  96
  97 All dependencies should be compiled with these flags:
  98
  99  -mmacosx-version-min=10.6
 100  -arch x86_64
 101  -isysroot $(xcode-select --print-path)/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.6.sdk
 102
 103 Once dependencies are compiled, see release-process.md for how the Bitcoin-Qt.app
 104 bundle is packaged and signed to create the .dmg disk image that is distributed.
 105
 106 Running
 107 -------
 108
 109 It's now available at `./bitcoind`, provided that you are still in the `src`
 110 directory. We have to first create the RPC configuration file, though.
 111
 112 Run `./bitcoind` to get the filename where it should be put, or just try these
 113 commands:
 114
 115     echo -e "rpcuser=bitcoinrpc\nrpcpassword=$(xxd -l 16 -p /dev/urandom)" > "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf"
 116     chmod 600 "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf"
 117
 118 The next time you run it, it will start downloading the blockchain, but it won't
 119 output anything while it's doing this. This process may take several hours;
 120 you can monitor its process by looking at the debug.log file, like this:
 121
 122     tail -f $HOME/Library/Application\ Support/Bitcoin/debug.log
 123
 124 Other commands:
 125 -------
 126
 127     ./bitcoind -daemon # to start the bitcoin daemon.
 128     ./bitcoin-cli --help  # for a list of command-line options.
 129     ./bitcoin-cli help    # When the daemon is running, to get a list of RPC commands