Jonas Nick 6145dc3032
Merge fort-nix/nix-bitcoin#539: Minor improvements
67a573dae86ae43d30395864351b81ec03c8bef8 create-git-repo.sh: fix amend error if there's no branch checked out (Erik Arvstedt)
d9eecb7d4c23a38e9eb3a31a434e7139fed57f86 nixos-search/flake: remove unused output (Erik Arvstedt)
4e70db14bcebf24449146d97e7c77b789be0de95 README: fix capitalization (Erik Arvstedt)
030be842c847aa45679010aa47f519732ad7fa9d secrets: use fetchurl derivation (Erik Arvstedt)
1713e016a031c8d366af44c6a47ea8084ca9dda5 clightning-replication: clarify comment about FUSE mounts (Erik Arvstedt)
cd3878e35755a80a1f5e1d94e91b469807be3d23 delete modules/default.nix (Erik Arvstedt)
f2a4d1fe650637a245b5c5ae35ea8ddf49d8504b docs/security: fix typo (Erik Arvstedt)
3a65dc0dc954273cd6a212e880449fade3e58eaf docs/configuration: improve section `Remote bitcoind` (Erik Arvstedt)
af115d746b2f96793cf39a1d5c1b11393da9b493 internal scripts: use pinned, cached pkgs (Erik Arvstedt)

Pull request description:

ACKs for top commit:
  jonasnick:
    ACK 67a573dae86ae43d30395864351b81ec03c8bef8

Tree-SHA512: 9ab2e9141793996eeae94cf2bb630491489a479841858187719fee9cf39e56b1db8bfc09f9466026b7409e160bb2047b374047ca4d2f7249077895c804663bd0
2022-08-29 11:38:48 +00:00
2022-08-29 00:12:17 +02:00
2022-08-28 23:49:12 +02:00
2022-08-21 10:23:33 +02:00
2022-08-21 19:11:51 +02:00
2019-01-02 14:03:52 +00:00
2020-01-09 10:43:29 +01:00
2022-08-29 00:12:18 +02:00
2022-08-28 23:49:12 +02:00
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.

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

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

Features

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)

Security

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.

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.

Languages
Nix 84.4%
Shell 11.7%
Python 3.5%
C 0.4%