mirror of
https://github.com/bitcoin/bitcoin.git
synced 2026-09-11 21:20:39 +02:00
17c5e33e9c
f4a6d079c4qa: Support `get_bind_addrs` and `feature_bind_extra` on illumos (Hennadii Stepanov)5e96a8fd5adoc: Add `lsof` to Test Suite Dependencies on NetBSD (Hennadii Stepanov)5d01aa4772qa: Ignore `lsof` warnings on NetBSD (Hennadii Stepanov)70352fda03qa: Strip prefix length from NetBSD `ifconfig` output (Hennadii Stepanov)1c1735567edoc: Add `lsof` to Test Suite Dependencies on FreeBSD (Hennadii Stepanov)4cb7f39c2cqa: Drop OpenBSD from supported platforms in `get_bind_addrs` function (Hennadii Stepanov)8a982eea85qa: Add `skip_if_no_lsof_on_nonlinux` helper and use it where needed (Hennadii Stepanov) Pull request description: This PR is a follow-up to #34256. It extends functional test support to illumos-based OSes and fixes several related issues on the *BSDs. Changes: - Make `lsof` an optional functional test dependency via a new `skip_if_no_lsof` helper, consistent with other optional test deps. - Strip the CIDR prefix length from NetBSD `ifconfig` output (no-op on other platforms). - Suppress spurious `lsof` warnings on NetBSD. - Drop OpenBSD from the platforms supported by `get_bind_addrs`. - Document the `lsof` Test Suite Dependency for FreeBSD and NetBSD. - Add support for `get_bind_addrs` and `feature_bind_extra` on illumos. CI runs: https://github.com/hebasto/bitcoin-core-nightly/pull/280. Addresses https://github.com/bitcoin/bitcoin/pull/34256#issuecomment-4361855749. ACKs for top commit: l0rinc: Lightly tested code review ACKf4a6d079c4sedited: utACKf4a6d079c4Tree-SHA512: 24d943d059f5fa3f5626017eff744836177a41724544355f34b3a31fdf287bd1916bc6e903b598c1c55b61da2ff0f931b4455542d9cff6cf399ef7963096dff4
106 lines
2.7 KiB
Markdown
106 lines
2.7 KiB
Markdown
# FreeBSD Build Guide
|
|
|
|
Bitcoin Core is supported on all [supported FreeBSD releases](https://www.freebsd.org/security/#sup).
|
|
|
|
This guide describes how to build bitcoind, command-line utilities, and GUI on the most recent production release.
|
|
|
|
## Preparation
|
|
|
|
### 1. Install Required Dependencies
|
|
Run the following as root to install the base dependencies for building.
|
|
|
|
```bash
|
|
pkg install boost-libs cmake git
|
|
```
|
|
|
|
SQLite is required for the wallet:
|
|
|
|
```bash
|
|
pkg install sqlite3
|
|
```
|
|
|
|
To build Bitcoin Core without the wallet, use `-DENABLE_WALLET=OFF`.
|
|
|
|
Cap'n Proto is needed for IPC functionality (see [multiprocess.md](multiprocess.md)):
|
|
|
|
```bash
|
|
pkg install capnproto
|
|
```
|
|
|
|
Compile with `-DENABLE_IPC=OFF` if you do not need IPC functionality.
|
|
|
|
See [dependencies.md](dependencies.md) for a complete overview.
|
|
|
|
### 2. Clone Bitcoin Repo
|
|
Now that `git` and all the required dependencies are installed, let's clone the Bitcoin Core repository to a directory. All build scripts and commands will run from this directory.
|
|
```bash
|
|
git clone https://github.com/bitcoin/bitcoin.git
|
|
```
|
|
|
|
### 3. Install Optional Dependencies
|
|
|
|
#### GUI Dependencies
|
|
###### Qt6
|
|
|
|
Bitcoin Core includes a GUI built with the cross-platform Qt Framework. To compile the GUI, we need to install
|
|
the necessary parts of Qt, the libqrencode and pass `-DBUILD_GUI=ON`. Skip if you don't intend to use the GUI.
|
|
|
|
```bash
|
|
pkg install qt6-base qt6-tools
|
|
```
|
|
|
|
###### libqrencode
|
|
|
|
The GUI will be able to encode addresses in QR codes unless this feature is explicitly disabled. To install libqrencode, run:
|
|
|
|
```bash
|
|
pkg install libqrencode
|
|
```
|
|
|
|
Otherwise, if you don't need QR encoding support, use the `-DWITH_QRENCODE=OFF` option to disable this feature in order to compile the GUI.
|
|
|
|
---
|
|
|
|
#### Notifications
|
|
###### ZeroMQ
|
|
|
|
Bitcoin Core can provide notifications via ZeroMQ. To compile ZMQ support, install the following dependency and pass `-DWITH_ZMQ=ON` when configuring.
|
|
```bash
|
|
pkg install libzmq4 pkgconf
|
|
```
|
|
|
|
#### Test Suite Dependencies
|
|
There is an included test suite that is useful for testing code changes when developing.
|
|
To run the test suite (recommended), you will need to have Python 3 installed:
|
|
|
|
```bash
|
|
pkg install python3 databases/py-sqlite3 net/py-pyzmq lsof
|
|
```
|
|
---
|
|
|
|
## Building Bitcoin Core
|
|
|
|
### 1. Configuration
|
|
|
|
There are many ways to configure Bitcoin Core, here are a few common examples:
|
|
|
|
##### Wallet and GUI:
|
|
This enables the GUI, assuming `sqlite` and `qt` are installed.
|
|
```bash
|
|
cmake -B build -DBUILD_GUI=ON
|
|
```
|
|
|
|
Run `cmake -B build -LH` to see the full list of available options.
|
|
|
|
##### No Wallet or GUI
|
|
```bash
|
|
cmake -B build -DENABLE_WALLET=OFF
|
|
```
|
|
|
|
### 2. Compile
|
|
|
|
```bash
|
|
cmake --build build # Append "-j N" for N parallel jobs.
|
|
ctest --test-dir build # Append "-j N" for N parallel tests.
|
|
```
|