mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-01-11 12:22:39 -03:00
eb3c6b0912
63ce882760doc: link to homebrew's troubleshooting page (Gastón I. Silva) Pull request description: A trivial documentation update. When I was following the build steps for mac, I had some errors installing the dependencies. After searching on the Internet, and correcting the errors, I found that `brew doctor` had all the answers I needed. Could have skipped the Internet searches all together. ACKs for top commit: fanquake: ACK63ce882760- a link to the troubleshooting page seems fine. I wouldn't really want our README to have anything more specific than that. Tree-SHA512: 12c96cd9c9bd39ada21f3f27cbec3ed4bef4b8e74dec7872c892fc6a92a70418a5cc0882ff449883e91d96c01e1ca7104b076590917f397334c82931ec7fda1c
116 lines
3.2 KiB
Markdown
116 lines
3.2 KiB
Markdown
# macOS Build Instructions and Notes
|
|
|
|
The commands in this guide should be executed in a Terminal application.
|
|
The built-in one is located in
|
|
```
|
|
/Applications/Utilities/Terminal.app
|
|
```
|
|
|
|
## Preparation
|
|
Install the macOS command line tools:
|
|
|
|
```shell
|
|
xcode-select --install
|
|
```
|
|
|
|
When the popup appears, click `Install`.
|
|
|
|
Then install [Homebrew](https://brew.sh).
|
|
|
|
## Dependencies
|
|
```shell
|
|
brew install automake berkeley-db4 libtool boost miniupnpc pkg-config python qt libevent qrencode
|
|
```
|
|
|
|
If you run into issues, check [Homebrew's troubleshooting page](https://docs.brew.sh/Troubleshooting).
|
|
See [dependencies.md](dependencies.md) for a complete overview.
|
|
|
|
If you want to build the disk image with `make deploy` (.dmg / optional), you need RSVG:
|
|
```shell
|
|
brew install librsvg
|
|
```
|
|
|
|
## Berkeley DB
|
|
It is recommended to use Berkeley DB 4.8. If you have to build it yourself,
|
|
you can use [this](/contrib/install_db4.sh) script to install it
|
|
like so:
|
|
|
|
```shell
|
|
./contrib/install_db4.sh .
|
|
```
|
|
|
|
from the root of the repository.
|
|
|
|
**Note**: You only need Berkeley DB if the wallet is enabled (see [*Disable-wallet mode*](/doc/build-osx.md#disable-wallet-mode)).
|
|
|
|
## Build Bitcoin Core
|
|
|
|
1. Clone the Bitcoin Core source code:
|
|
```shell
|
|
git clone https://github.com/bitcoin/bitcoin
|
|
cd bitcoin
|
|
```
|
|
|
|
2. Build Bitcoin Core:
|
|
|
|
Configure and build the headless Bitcoin Core binaries as well as the GUI (if Qt is found).
|
|
|
|
You can disable the GUI build by passing `--without-gui` to configure.
|
|
```shell
|
|
./autogen.sh
|
|
./configure
|
|
make
|
|
```
|
|
|
|
3. It is recommended to build and run the unit tests:
|
|
```shell
|
|
make check
|
|
```
|
|
|
|
4. You can also create a `.dmg` that contains the `.app` bundle (optional):
|
|
```shell
|
|
make deploy
|
|
```
|
|
|
|
## `disable-wallet` mode
|
|
When the intention is to run only a P2P node without a wallet, Bitcoin Core may be
|
|
compiled in `disable-wallet` mode with:
|
|
```shell
|
|
./configure --disable-wallet
|
|
```
|
|
|
|
In this case there is no dependency on Berkeley DB 4.8.
|
|
|
|
Mining is also possible in disable-wallet mode using the `getblocktemplate` RPC call.
|
|
|
|
## Running
|
|
Bitcoin Core is now available at `./src/bitcoind`
|
|
|
|
Before running, you may create an empty configuration file:
|
|
```shell
|
|
mkdir -p "/Users/${USER}/Library/Application Support/Bitcoin"
|
|
|
|
touch "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf"
|
|
|
|
chmod 600 "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf"
|
|
```
|
|
|
|
The first time you run bitcoind, it will start downloading the blockchain. This process could
|
|
take many hours, or even days on slower than average systems.
|
|
|
|
You can monitor the download process by looking at the debug.log file:
|
|
```shell
|
|
tail -f $HOME/Library/Application\ Support/Bitcoin/debug.log
|
|
```
|
|
|
|
## Other commands:
|
|
```shell
|
|
./src/bitcoind -daemon # Starts the bitcoin daemon.
|
|
./src/bitcoin-cli --help # Outputs a list of command-line options.
|
|
./src/bitcoin-cli help # Outputs a list of RPC commands when the daemon is running.
|
|
```
|
|
|
|
## Notes
|
|
* Tested on OS X 10.12 Sierra through macOS 10.15 Catalina on 64-bit Intel
|
|
processors only.
|
|
* Building with downloaded Qt binaries is not officially supported. See the notes in [#7714](https://github.com/bitcoin/bitcoin/issues/7714).
|