README.md

Ferrite Core

Setup

Ferrite Core is the original Ferrite client and it builds the backbone of the network. It downloads and, by default, stores the entire history of Ferrite transactions, which requires approximately 22 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 Ferrite Core, visit ferritecoin.org.

Running

The following are some helpful notes on how to run Ferrite Core on your native platform.

Unix

Unpack the files into a directory and run:

• bin/ferrite-qt (GUI) or
• bin/ferrited (headless)

Windows

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

macOS

Drag Ferrite Core to your applications folder, and then run Ferrite Core.

Need Help?

• See the documentation at the Ferrite Github Wiki for help and more information.
• Ask for help on ferrite_core on Telegram. If you prefer to stay pseudonymous, use Ferritext
• Ask for help on the Ferrite Forum forums, in the Technical Support board.

Building

The following are developer notes on how to build Ferrite 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 Ferrite 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 FerriteTalk forums.
• Discuss general Ferrite development on #ferrite-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.