highperfocused/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-08-23 21:32:33 +02:00
Code Issues Packages Projects Releases Wiki Activity

doc: update build and dependencies docs for IPC

Browse Source 
OpenBSD does not have this package, so recommend building from
source for now.
This commit is contained in:
Sjors Provoost
2025-08-12 16:36:50 +02:00
parent 3cbf747c32
commit 71f29d4fa9
6 changed files with 37 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/build-freebsd.md
View File

@@ -21,6 +21,14 @@ 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

8
doc/build-netbsd.md
View File

@@ -39,6 +39,14 @@ pkgin 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
pkgin 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

5
doc/build-openbsd.md
View File

@@ -21,6 +21,11 @@ pkg_add 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))
and can be built from source: https://capnproto.org/install.html
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

20
doc/build-osx.md
View File

@@ -48,7 +48,7 @@ See [dependencies.md](dependencies.md) for a complete overview.
To install, run the following from your terminal:
``` bash
brew install cmake boost pkgconf libevent
brew install cmake boost pkgconf libevent capnp
```
#### Wallet Dependencies
@@ -59,6 +59,11 @@ the `cmake -B` step below.
SQLite is required, but since macOS ships with a useable `sqlite` package, you don't need to
install anything.
#### IPC Dependencies
If you do not need IPC functionality (see [multiprocess.md](multiprocess.md))
you can omit `capnp` and use `-DENABLE_IPC=OFF` in the `cmake -B` step below.
### 4. Clone Bitcoin repository
`git` should already be installed by default on your system.
@@ -112,19 +117,6 @@ For more information on ZMQ, see: [zmq.md](zmq.md)
---
### IPC Dependencies
Compiling IPC-enabled binaries with `-DENABLE_IPC=ON` requires the following dependency.
Skip if you do not need IPC functionality.
```bash
brew install capnp
```
For more information on IPC, see: [multiprocess.md](multiprocess.md).
---
#### Test Suite Dependencies
There is an included test suite that is useful for testing code changes when developing.

16
doc/build-unix.md
View File

@@ -60,6 +60,12 @@ SQLite is required for the wallet:
To build Bitcoin Core without the wallet, see [*Disable-wallet mode*](#disable-wallet-mode)
Cap'n Proto is needed for IPC functionality (see [multiprocess.md](multiprocess.md)):
sudo apt-get install libcapnp-dev capnproto
Compile with `-DENABLE_IPC=OFF` if you do not need IPC functionality.
ZMQ-enabled binaries are compiled with `-DWITH_ZMQ=ON` and require the following dependency:
sudo apt-get install libzmq3-dev
@@ -68,11 +74,6 @@ User-Space, Statically Defined Tracing (USDT) dependencies:
sudo apt install systemtap-sdt-dev
IPC-enabled binaries are compiled with `-DENABLE_IPC=ON` and require the following dependencies.
Skip if you do not need IPC functionality.
sudo apt-get install libcapnp-dev capnproto
GUI dependencies:
Bitcoin Core includes a GUI built with the cross-platform Qt Framework. To compile the GUI, we need to install
@@ -119,11 +120,12 @@ User-Space, Statically Defined Tracing (USDT) dependencies:
sudo dnf install systemtap-sdt-devel
IPC-enabled binaries are compiled with `-DENABLE_IPC=ON` and require the following dependency.
Skip if you do not need IPC functionality.
Cap'n Proto is needed for IPC functionality (see [multiprocess.md](multiprocess.md)):
sudo dnf install capnproto
Compile with `-DENABLE_IPC=OFF` if you do not need IPC functionality.
GUI dependencies:
Bitcoin Core includes a GUI built with the cross-platform Qt Framework. To compile the GUI, we need to install

1
doc/dependencies.md
View File

@@ -35,6 +35,7 @@ Bitcoin Core requires one of the following compilers.
| Dependency | Releases | Minimum required |
| --- | --- | --- |
| [Cap'n Proto](../depends/packages/capnp.mk) | [link](https://capnproto.org) | [0.7.1](https://capnproto.org/install.html) |
| Python (scripts, tests) | [link](https://www.python.org) | [3.10](https://github.com/bitcoin/bitcoin/pull/30527) |
| [Qt](../depends/packages/qt.mk) (gui) | [link](https://download.qt.io/archive/qt/) | [6.2](https://github.com/bitcoin/bitcoin/pull/30997) |
| [qrencode](../depends/packages/qrencode.mk) (gui) | [link](https://fukuchi.org/works/qrencode/) | N/A |