bitcoin/doc

Bitcoin Core

Setup

Bitcoin Core 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 Core, visit bitcoincore.org.

Running

The following are some helpful notes on how to run Bitcoin Core 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 Core to your applications folder, and then run Bitcoin Core.

Need Help?

• See the documentation at the Bitcoin Wiki for help and more information.
• Ask for help on #bitcoin on Freenode. If you don't have an IRC client, use webchat here.
• Ask for help on the BitcoinTalk forums, in the Technical Support board.

Building

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

• Dependencies
• macOS Build Notes
• Unix Build Notes
• Windows Build Notes
• FreeBSD Build Notes
• OpenBSD Build Notes
• NetBSD Build Notes
• Gitian Building Guide (External Link)

Development

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

• Developer Notes
• Productivity Notes
• Release Notes
• Release Process
• Source Code Documentation (External Link)
• Translation Process
• Translation Strings Policy
• JSON-RPC Interface
• Unauthenticated REST Interface
• Shared Libraries
• BIPS
• Dnsseed Policy
• Benchmarking

Resources

• Discuss on the BitcoinTalk forums, in the Development & Technical Discussion board.
• Discuss project-specific development on #bitcoin-core-dev on Freenode. If you don't have an IRC client, use webchat here.
• Discuss general Bitcoin development on #bitcoin-dev on Freenode. If you don't have an IRC client, use webchat here.

Miscellaneous

• Assets Attribution
• bitcoin.conf Configuration File
• Files
• Fuzz-testing
• Reduce Memory
• Reduce Traffic
• Tor Support
• Init Scripts (systemd/upstart/openrc)
• ZMQ
• PSBT support

License

Distributed under the MIT software license. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. This product includes cryptographic software written by Eric Young (eay@cryptsoft.com), and UPnP software written by Thomas Bernard.