Inside Bitcoin

Opening the selected file…

₿MyBitcoinExplorer

Bitcoin, in focus.
Explore the network. Understand the connections.

Explore Bitcoin with clarity.

READ THE CODE

Inside Bitcoin

The code behind the network, with room to understand it.

Stable release v32.1bitcoin/bitcoin · f0de87f04062 ↗3,020 source files · 47.5 MB stored on the server340 file guides

Release published 2026-10-28 · Snapshot fetched 2026-11-01. Latest stable release at fetch time; development branches and Git history are excluded. Only the selected code window and visible folders load here.

bitcoin / bitcoinstable

Find a file

▤ assets-attribution.md

▤ assumeutxo.md

▤ benchmarking.md

▤ bips.md

▤ bitcoin_logo_doxygen.png

▤ build-windows-msvc.md

▤ JSON-RPC-interface.md

▤ managing-wallets.md

▤ multiprocess.md

▤ multisig-tutorial.md

▤ offline-signing-tutorial.md

▤ translation_process.md

▤ translation_strings_policy.md

▤ CMakeLists.txtGuide

▤ libbitcoinkernel.pc.in

bitcoin / doc / build-unix.md

Download source ↓

4,372 bytes · SHA-256 119b48d645bddbe9… · View upstream ↗

1# UNIX BUILD NOTES
2
3Some notes on how to build Bitcoin Core in Unix.
4
5(For BSD specific instructions, see `build-*bsd.md` in this directory.)
6
7## To Build
8
9```bash
10cmake -B build
11```
12Run `cmake -B build -LH` to see the full list of available options.
13
14```bash
15cmake --build build    # Append "-j N" for N parallel jobs
16cmake --install build  # Optional
17```
18
19See below for instructions on how to [install the dependencies on popular Linux
20distributions](#dependencies).
21
22## Memory Requirements
23
24C++ compilers are memory-hungry. It is recommended to have at least 1.5 GB of
25memory available when compiling Bitcoin Core. On systems with less, gcc can be
26tuned to conserve memory with additional `CMAKE_CXX_FLAGS`:
27
28
29    cmake -B build -DCMAKE_CXX_FLAGS="--param ggc-min-expand=1 --param ggc-min-heapsize=32768"
30
31Alternatively, or in addition, debugging information can be skipped for compilation.
32For the default build type `RelWithDebInfo`, the default compile flags are
33`-O2 -g`, and can be changed with:
34
35    cmake -B build -DCMAKE_CXX_FLAGS_RELWITHDEBINFO="-O2 -g0"
36
37Finally, clang (often less resource hungry) can be used instead of gcc, which is used by default:
38
39    cmake -B build -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang
40
41## Dependencies
42
43You can either build from self-compiled [depends](/depends/README.md) or
44install the dependencies from your distribution package manager. Dependencies
45for additional features in later columns are optional.
46
47| Package manager         | Required build dependencies | SQLite (wallet) | Cap'n Proto (IPC) | ZMQ <sup><a href="#note1">[1]</a></sup> | USDT | Qt and libqrencode (GUI) |
48| ----------------------- | --------------------------- | --------------- | ----------------- | --- | ---- | ------------------------ |
49| Debian / Ubuntu (`apt`) | `build-essential cmake python3 libboost-dev` | `libsqlite3-dev` | `libcapnp-dev capnproto` | `libzmq3-dev pkgconf` | `systemtap-sdt-dev` | `qt6-base-dev qt6-tools-dev qt6-l10n-tools qt6-tools-dev-tools libgl-dev qt6-wayland libqrencode-dev` |
50| Fedora (`dnf`)          | `gcc-c++ cmake make python3 boost-devel` | `sqlite-devel` | `capnproto capnproto-devel` | `zeromq-devel pkgconf` | `systemtap-sdt-devel` | `qt6-qtbase-devel qt6-qttools-devel qt6-qtwayland qrencode-devel` |
51| Alpine (`apk`)          | `build-base cmake linux-headers python3 boost-dev` | `sqlite-dev` | `capnproto capnproto-dev` | `zeromq-dev` | Not supported | `qt6-qtbase-dev qt6-qttools-dev libqrencode-dev` |
52| Arch (`pacman`)         | `gcc make cmake python boost` | `sqlite` | `capnproto` | `zeromq` | `systemtap` | `qt6-base qt6-tools qt6-wayland qrencode` |
53
54<a id="note1"></a>1. Some ZMQ packages do not vendor the CMake config files, which requires `pkgconf` or `pkg-config` to be installed.
55
56For Debian "oldstable", or earlier Ubuntu LTS releases, you may need to pick a
57later compiler version, according to the [dependencies](/doc/dependencies.md)
58documentation.
59
60To build Bitcoin Core without the wallet, see [*Disable-wallet mode*](#disable-wallet-mode)
61and use `-DENABLE_WALLET=OFF` to build without the wallet and skip the SQLite dependency.
62
63Cap'n Proto is needed for IPC functionality (see [multiprocess.md](multiprocess.md)).
64Compile with `-DENABLE_IPC=OFF` if you do not need IPC functionality.
65
66ZMQ-enabled binaries are compiled with `-DWITH_ZMQ=ON` and require libzmq.
67
68User-Space, Statically Defined Tracing (USDT) requires the systemtap-sdt
69development package and must be enabled via `-DWITH_USDT=ON`.
70
71GUI dependencies:
72
73Bitcoin Core includes a GUI built with the cross-platform Qt Framework. To compile the GUI, we need to install
74the necessary parts of Qt, the libqrencode and pass `-DBUILD_GUI=ON`. Skip if you don't intend to use the GUI.
75
76Additionally, install the Qt Wayland platform plugin for modern desktop environments.
77
78The GUI will be able to encode addresses in QR codes and requires libqrencode.
79Otherwise, if you don't need QR encoding support, use the `-DWITH_QRENCODE=OFF` option to disable this feature in order to compile the GUI.
80
81### Disable-wallet mode
82
83When the intention is to only run a P2P node, without a wallet, Bitcoin Core can
84be compiled in disable-wallet mode with:
85
86    cmake -B build -DENABLE_WALLET=OFF
87
88In this case there is no dependency on SQLite.
89
90Mining is also possible in disable-wallet mode using the `getblocktemplate` RPC call.
91

A READING COMPANION

Source available. Guide coming next.

This file is included in the stable source snapshot. A file-specific guide has not been published yet.

340 guided files · 2,680 pending. Guides cover key sections, not every line.

cmake/bitcoin-build-config.h.in src/consensus/amount.h src/consensus/consensus.h src/primitives/block.h src/primitives/transaction.h src/crypto/sha256.h src/util/moneystr.h src/clientversion.h src/uint256.h src/script/script.h src/policy/policy.h CMakeLists.txt README.md COPYING src/consensus/tx_check.cpp src/consensus/tx_verify.cpp src/consensus/merkle.cpp src/pow.cpp src/validation.cpp src/script/interpreter.cpp src/script/solver.cpp src/script/sign.cpp src/key_io.cpp src/net.cpp src/net_processing.cpp src/netaddress.cpp src/protocol.h src/wallet/wallet.cpp src/wallet/spend.cpp

Code page 1

src/wallet/receive.cpp

src/wallet/coinselection.cpp

src/consensus/validation.h

src/primitives/transaction.cpp

src/script/descriptor.cpp

src/bitcoin-cli.cpp

src/rpc/blockchain.cpp

src/rpc/rawtransaction.cpp

src/init.cpp

src/crypto/sha256.cpp

src/consensus/merkle.h

src/consensus/tx_check.h

src/consensus/tx_verify.h

src/policy/feerate.h

src/policy/feerate.cpp

src/primitives/transaction_identifier.h

src/chainparamsbase.h

src/chainparamsbase.cpp

src/util/moneystr.cpp

src/crypto/ripemd160.h

src/crypto/sha1.h

src/crypto/sha512.h

src/crypto/hmac_sha256.h

src/crypto/hmac_sha512.h

src/crypto/hmac_sha256.cpp

src/crypto/hmac_sha512.cpp

src/crypto/hkdf_sha256_32.h

src/crypto/hkdf_sha256_32.cpp

src/support/cleanse.h

src/support/cleanse.cpp

src/crypto/siphash.cpp

src/crypto/muhash.h

src/crypto/chacha20.h

src/crypto/poly1305.h

src/crypto/chacha20poly1305.h

src/crypto/chacha20poly1305.cpp

src/util/chaintype.cpp

src/util/obfuscation.h

src/util/byte_units.h

src/util/overflow.h

src/blockencodings.cpp

src/net_permissions.cpp

src/policy/packages.cpp

src/policy/rbf.cpp

src/policy/truc_policy.cpp

src/policy/ephemeral_policy.cpp

src/policy/settings.cpp

src/policy/policy.cpp

src/node/transaction.cpp

src/node/coin.cpp

src/rpc/client.cpp

src/rpc/external_signer.cpp

src/rpc/request.cpp

src/rpc/server_util.cpp

src/rpc/fees.cpp

src/rpc/output_script.cpp

src/rpc/rawtransaction_util.cpp

src/rpc/rawtransaction_util.h

src/rpc/register.h

src/rpc/request.h

src/rpc/server_util.h

src/rpc/protocol.h

src/rpc/server.h

src/rpc/signmessage.cpp

src/rpc/txoutproof.cpp

src/rpc/util.cpp

src/rpc/util.h

src/wallet/rpc/addresses.cpp

src/wallet/rpc/backup.cpp

src/wallet/rpc/coins.cpp

src/wallet/rpc/encrypt.cpp

src/wallet/rpc/signmessage.cpp

src/wallet/rpc/util.cpp

src/wallet/rpc/util.h

src/wallet/coincontrol.cpp

src/wallet/coincontrol.h

src/wallet/context.cpp

src/wallet/context.h

src/wallet/crypter.cpp

src/wallet/crypter.h

src/wallet/db.cpp

src/wallet/export.cpp

src/wallet/external_signer_scriptpubkeyman.cpp

src/wallet/rpc/spend.cpp

src/wallet/rpc/transactions.cpp

src/wallet/rpc/wallet.cpp

src/wallet/feebumper.cpp

src/wallet/feebumper.h

src/index/base.h

src/index/base.cpp

src/index/txindex.h

src/index/txindex.cpp

src/index/txindex_key.h

src/index/txospenderindex.h

src/index/txospenderindex.cpp

src/index/blockfilterindex.h

src/index/blockfilterindex.cpp

src/index/coinstatsindex.h

src/index/coinstatsindex.cpp

src/index/db_key.h

src/index/disktxpos.h

src/kernel/chain.cpp

src/kernel/chain.h

src/kernel/checks.cpp

src/kernel/checks.h

src/kernel/context.cpp

src/kernel/context.h

src/kernel/cs_main.cpp

src/kernel/cs_main.h

src/kernel/disconnected_transactions.cpp

src/kernel/disconnected_transactions.h

src/kernel/mempool_removal_reason.cpp

src/kernel/mempool_removal_reason.h

src/kernel/coinstats.cpp

src/kernel/coinstats.h

src/kernel/chainparams.cpp

src/kernel/chainparams.h

src/wallet/sqlite.cpp

src/wallet/sqlite.h

src/wallet/transaction.cpp

src/wallet/transaction.h

src/wallet/dump.cpp

src/wallet/dump.h

src/wallet/init.cpp

src/wallet/walletutil.cpp

src/wallet/walletutil.h

src/wallet/wallettool.cpp

src/wallet/wallettool.h

src/wallet/export.h

src/wallet/migrate.cpp

src/wallet/migrate.h

src/wallet/db.h

src/wallet/walletdb.cpp

src/wallet/interfaces.cpp

src/wallet/scriptpubkeyman.cpp

src/wallet/scriptpubkeyman.h

src/kernel/bitcoinkernel.cpp

src/kernel/bitcoinkernel.h

src/kernel/bitcoinkernel_wrapper.h

src/node/chainstate.cpp

src/node/chainstate.h

src/node/blockstorage.cpp

src/node/blockstorage.h

src/node/mempool_persist.cpp

src/node/mempool_persist.h

src/node/utxo_snapshot.cpp

src/node/utxo_snapshot.h

src/node/kernel_notifications.cpp

src/node/kernel_notifications.h

src/node/blockmanager_args.cpp

src/kernel/blockmanager_opts.h

src/util/expected.cpp

src/policy/settings.h

src/util/types.h

src/kernel/messagestartchars.h

src/kernel/warning.h

src/util/exception.h

src/common/license_info.h

src/node/coins_view_args.h

src/node/database_args.h

src/util/batchpriority.h

src/util/ui_change_type.h

src/node/coins_view_args.cpp

src/node/peerman_args.h

src/util/serfloat.h

src/node/blockmanager_args.h

src/node/database_args.cpp

src/util/overloaded.h

src/interfaces/types.h

src/node/chainstatemanager_args.h

src/node/minisketchwrapper.h

src/util/macros.h

src/util/syserror.h

src/common/run_command.h

src/util/bytevectorhash.cpp

src/node/mempool_persist_args.cpp

src/util/exec.h

src/util/rbf.h

src/crypto/hex_base.h

src/node/mempool_persist_args.h

src/interfaces/echo.h

src/util/any.h

src/util/batchpriority.cpp

src/util/threadnames.h

src/node/coin.h

src/node/mempool_args.h

src/util/asmap.h

src/util/bytevectorhash.h

src/node/context.cpp

src/util/insert.h

src/util/readwritefile.h

src/node/peerman_args.cpp

src/node/interface_ui.cpp

src/interfaces/handler.h

src/node/mining_args.h

src/util/hasher.cpp

src/common/init.h

src/kernel/mempool_limits.h

src/common/system.h

src/crypto/sha3.h

src/util/threadinterrupt.cpp

src/node/protocol_version.h

src/util/exception.cpp

src/common/messages.h

src/node/connection_types.cpp

src/util/bip32.h

src/common/license_info.cpp

src/util/stdmutex.h

src/common/run_command.cpp

src/util/check.cpp

src/util/golombrice.h

src/node/types.h

src/node/timeoffsets.h

src/util/readwritefile.cpp

src/util/fastrange.h

src/util/signalinterrupt.h

src/util/task_runner.h

src/util/syserror.cpp

src/common/interfaces.cpp

src/common/types.h

src/util/threadinterrupt.h

src/kernel/chainstatemanager_opts.h

src/node/psbt.h

src/policy/ephemeral_policy.h

src/util/trace.h

src/common/url.cpp

src/kernel/mempool_options.h

src/util/serfloat.cpp

src/kernel/notifications_interface.h

src/node/timeoffsets.cpp

src/node/warnings.cpp

src/util/hash_type.h

src/crypto/hex_base.cpp

src/node/eviction.h

src/util/tokenbucket.h

src/crypto/aes.h

src/common/pcp.h

src/util/feefrac.cpp

src/node/transaction.h

src/util/threadnames.cpp

src/common/signmessage.h

src/util/exec.cpp

src/util/signalinterrupt.cpp

Independent explanations by MyBitcoinExplorer. Not affiliated with or endorsed by Bitcoin Core. Guides are educational and do not replace the source or its tests.

Bitcoin Core source © its contributors, distributed under the MIT license. Original notices and bundled third-party licenses are retained in the source tree.