bitcoin/doc
2025-03-05 03:27:08 +00:00
..
design Revert "remove libbitcoinconsensus" 2025-03-05 17:54:44 +00:00
man Update manpages, bash completion, and example bitcoin.conf 2025-03-05 03:27:08 +00:00
policy [doc] update documentation for new mempoolfullrbf default 2024-08-07 10:19:52 +01:00
release-notes doc: Archive 28.0 release notes 2024-10-16 16:25:33 +01:00
.gitignore Ignore Doxyfile generated from Doxyfile.in template. 2017-04-07 16:28:12 +02:00
assets-attribution.md [doc] Merge doc/assets-attribution.md into contrib/debian/copyright 2015-09-18 18:14:42 +02:00
benchmarking.md doc: update doc/benchmarking.md 2021-06-24 11:15:29 +02:00
bips.md Update documented versions/BIPs for Knots 2025-03-05 03:27:08 +00:00
bitcoin_logo_doxygen.png Lossless image optimization 2013-12-02 10:10:22 +01:00
bitcoin-conf.md doc: add testnet4 section header for config file 2024-10-22 16:04:04 +01:00
build-freebsd.md doc: suggest only necessary Qt packages for installation on FreeBSD 2024-04-24 14:14:18 +02:00
build-netbsd.md doc: Update NetBSD Build Guide 2024-05-20 12:59:15 +01:00
build-openbsd.md doc: mention optional dependencies (qrencode, zmq) in OpenBSD build docs 2024-07-30 22:34:35 +02:00
build-osx.md doc: add LLVM instruction for macOS < 13 2024-04-29 10:33:21 +02:00
build-unix.md build-unix: Update for SVG sources 2025-02-07 20:43:51 +00:00
build-windows.md Merge bitcoin/bitcoin#30580: doc: Add note about distro's g++-mingw-w64-x86-64-posix version 2024-08-12 11:40:22 +01:00
cjdns.md doc: update getnodeaddresses for CJDNS, I2P and Tor and rm link 2023-06-01 15:52:51 +02:00
dependencies.md build: Bump clang minimum supported version to 16 2024-06-26 18:48:05 +02:00
descriptors.md doc: update descriptors.md for getdescriptoractivity 2024-11-27 20:36:09 +00:00
developer-notes.md Fix lint-spelling warnings 2024-07-22 13:59:42 +02:00
dnsseed-policy.md Update the developer mailing list address. 2024-04-02 15:38:40 -03:00
Doxyfile.in Update project name to Knots in Doxyfile 2025-02-07 18:20:49 +00:00
external-signer.md wallet: compare address returned by displayaddress 2024-04-16 17:47:43 +02:00
files.md Merge 11082 via rwconf-27+knots 2025-03-05 03:27:08 +00:00
fuzzing.md doc: remove references to disable-asm option now that it's gone 2024-02-29 19:10:31 +00:00
guix.md docs: Point to contrib/guix/README.md in doc/guix.md 2021-01-08 11:40:01 -05:00
i2p.md doc: i2p: improve -i2pacceptincoming mention 2024-04-04 18:32:39 -03:00
init.md Merge bitcoin/bitcoin#28167: init: Add option for rpccookie permissions (replace 26088) 2024-06-27 17:35:08 -04:00
JSON-RPC-interface.md minor: remove unnecessary semicolons from RPC content type examples 2024-06-07 10:47:24 -04:00
managing-wallets.md Merge bitcoin/bitcoin#27064: system: use %LOCALAPPDATA% as default datadir on windows 2024-05-23 12:11:55 -04:00
multiprocess.md doc: Add multiprocess design doc 2023-12-22 16:23:33 -05:00
multisig-tutorial.md doc: remove obsolete mention and link to closed PR 2024-07-31 12:38:29 +02:00
offline-signing-tutorial.md doc: update signet faucet link in offline-signing-tutorial.md 2024-03-04 00:14:29 +07:00
p2p-bad-ports.md init, doc: improve -onlynet help and tor/i2p documentation 2022-03-03 16:14:01 +01:00
productivity.md doc: Update ccache website link 2024-08-11 16:19:57 +01:00
psbt.md doc: M-of-N multisig using descriptor wallets and PSBTs, as well as a signing flow 2021-08-16 10:43:07 +05:00
README_doxygen.md doc: Improve doxygen readme navigation section 2019-09-23 19:22:06 -04:00
README_windows.txt Knots branding for README and GitHub issue templates 2025-02-07 18:20:49 +00:00
README.md Merge knots_branding-28 2025-03-05 03:27:08 +00:00
reduce-memory.md doc: Be vague instead of wrong about MALLOC_ARENA_MAX 2023-09-20 17:12:24 +00:00
reduce-traffic.md doc: update/clarify max outbound connection count 2023-12-11 20:05:25 +01:00
release-notes.md doc/release-notes: Update for Bitcoin Knots 28.1.knots20250305 2025-03-05 03:27:08 +00:00
release-process.md testnet: Introduce Testnet4 2024-08-06 01:38:10 +02:00
REST-interface.md rest: add endpoint for estimatesmartfee 2025-02-24 19:53:44 +00:00
shared-libraries.md Revert "libconsensus: deprecate" 2025-03-05 17:54:44 +00:00
tor.md doc: tor.md: use -bind=127.0.0.1:8334=onion for the Tor bind 2024-08-02 09:45:16 +02:00
tracing.md Use int32_t type for most transaction size/weight values 2023-06-12 19:47:19 +01:00
translation_process.md doc: Update translation_process.md 2024-02-14 21:39:39 -03:00
translation_strings_policy.md doc: Do not translate technical or extremely rare errors 2020-05-05 04:46:08 +03:00
zmq.md doc/zmq: Add detailed descriptions for {hash,raw}wallettx topics 2024-11-24 23:44:40 +00:00

Bitcoin Knots

Setup

Bitcoin Knots is the original Bitcoin client and it builds the backbone of the network. It downloads and, by default, stores the entire history of Bitcoin transactions, which requires a few hundred gigabytes of disk space. Depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more.

To download Bitcoin Knots, visit bitcoinknots.org.

Running

The following are some helpful notes on how to run Bitcoin Knots on your native platform.

Unix

Unpack the files into a directory and run:

  • bin/bitcoin-qt (GUI) or
  • bin/bitcoind (headless)

Windows

Unpack the files into a directory, and then run bitcoin-qt.exe.

macOS

Drag Bitcoin Knots to your applications folder, and then run Bitcoin Knots.

Need Help?

Building

The following are developer notes on how to build Bitcoin Knots on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.

Development

The Bitcoin repo's root README contains relevant information on the development process and automated testing.

Resources

Miscellaneous

License

Distributed under the MIT software license.