Go to file
Erik Arvstedt cd3878e357
delete modules/default.nix
This file has been missing some modules for quite some time.
Remove it to simplify maintenance.
2022-08-28 23:49:12 +02:00
docs docs/configuration: improve section Remote bitcoind 2022-08-28 23:49:12 +02:00
examples shellcheck: fix lint of scripts in tests 2022-08-28 18:25:37 +02:00
helper internal scripts: use pinned, cached pkgs 2022-08-28 23:49:12 +02:00
modules delete modules/default.nix 2022-08-28 23:49:12 +02:00
pkgs internal scripts: use pinned, cached pkgs 2022-08-28 23:49:12 +02:00
test internal scripts: use pinned, cached pkgs 2022-08-28 23:49:12 +02:00
.cirrus.yml internal scripts: use pinned, cached pkgs 2022-08-28 23:49:12 +02:00
default.nix delete modules/default.nix 2022-08-28 23:49:12 +02:00
flake.lock update nixpkgs 2022-08-21 10:23:33 +02:00
flake.nix pkgs: add fetch-node-modules 2022-08-21 19:11:51 +02:00
LICENSE Add license 2019-01-02 14:03:52 +00:00
overlay.nix simplify overlay.nix 2020-01-09 10:43:29 +01:00
README.md clightning: native database replication 2022-08-05 13:48:24 +00:00
SECURITY.md docs/security: fix typo 2022-08-28 23:49:12 +02:00
shell.nix Clean up development shell.nix 2020-03-30 10:49:15 +02:00

nix-bitcoin logo

CirrusCI status GitHub tag (latest SemVer) GitHub commit activity GitHub contributors GitHub downloads

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


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


Hint: To show a table of contents, click the button (Github TOC button) in the top left corner of the documents.


A configuration preset for setting up a secure node

  • All applications use Tor for outbound connections and support accepting inbound connections via onion services.

NixOS modules (src)


See SECURITY.md for the security policy and how to report a vulnerability.

nix-bitcoin aims to achieve a high degree of security by building on the following principles:

  • Simplicity: Only services enabled in configuration.nix and their dependencies are installed, support for doas (sudo alternative), code is continuously reviewed and refined.
  • Integrity: The Nix package manager guarantees that all dependencies are exactly specified, packages can be built from source to reduce reliance on binary caches, nix-bitcoin merge commits are signed, all commits are approved by multiple nix-bitcoin developers, upstream packages are cryptographically verified where possible, we use this software ourselves.
  • Principle of Least Privilege: Services operate with least privileges; they each have their own user and are restricted further with systemd features, RPC whitelisting and netns-isolation. There's a non-root user operator to interact with the various services.
  • Defense-in-depth: nix-bitcoin supports a hardened kernel, services are confined through discretionary access control, Linux namespaces, dbus firewall and seccomp-bpf with continuous improvements.

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

Security fund

The nix-bitcoin security fund is a 2 of 3 bitcoin multisig address open for donations, used to reward security researchers who discover vulnerabilities in nix-bitcoin or its upstream dependencies.
See Security Fund for details.


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.