Home

Awesome

<p align="center"> <img width="320" src="docs/img/nix-bitcoin-logo.png" alt="nix-bitcoin logo"> </p> <br/> <p align="center"> <a href="https://cirrus-ci.com/github/fort-nix/nix-bitcoin" target="_blank"> <img src="https://api.cirrus-ci.com/github/fort-nix/nix-bitcoin.svg?branch=master" alt="CirrusCI status"> </a> <a href="https://github.com/fort-nix/nix-bitcoin/releases/latest" target="_blank"> <img src="https://img.shields.io/github/v/release/fort-nix/nix-bitcoin" alt="GitHub tag (latest SemVer)"> </a> <a href="https://github.com/fort-nix/nix-bitcoin/commits/master" target="_blank"> <img src="https://img.shields.io/github/commit-activity/y/fort-nix/nix-bitcoin" alt="GitHub commit activity"> </a> <a href="https://github.com/fort-nix/nix-bitcoin/graphs/contributors" target="_blank"> <img src="https://img.shields.io/github/contributors-anon/fort-nix/nix-bitcoin" alt="GitHub contributors"> </a> <a href="https://github.com/fort-nix/nix-bitcoin/releases" target="_blank"> <img src="https://img.shields.io/github/downloads/fort-nix/nix-bitcoin/total" alt="GitHub downloads"> </a> </p> <br/>

nix-bitcoin is a collection of Nix packages and NixOS modules for easily installing full-featured Bitcoin nodes with an emphasis on security.

Overview

nix-bitcoin can be used for personal or merchant wallets, public infrastructure or for Bitcoin application backends. In all cases, the aim is to provide security and privacy by default. However, while nix-bitcoin is used in production today, it is still considered experimental.

nix-bitcoin nodes can be deployed on dedicated hardware, virtual machines or containers. The Nix packages and NixOS modules can be used independently and combined freely.

nix-bitcoin is built on top of Nix and NixOS which provide powerful abstractions to keep it highly customizable and maintainable. Testament to this are nix-bitcoin's robust security features and its potent test framework. However, running nix-bitcoin does not require any previous experience with the Nix ecosystem.

Get started

Docs

Features

A configuration preset for setting up a secure node

NixOS modules (src)

Security

Note that if the machine you're deploying from is insecure, there is nothing nix-bitcoin can do to protect itself.

Troubleshooting

If you are having problems with nix-bitcoin check the FAQ or submit an issue.
There's also a Matrix room at #general:nixbitcoin.org and a #nix-bitcoin IRC channel on libera.
We are always happy to help.