1b3d3620fb
2f0f1ec15aa5010864584fcaf828868b56421687 hardened-extended: define kernelParams as separate strings (Erik Arvstedt)
71e98640600319df3c8e024b72dd682d09622f26 netns-isolation: add compatibility with 21.11 (Erik Arvstedt)
8f641756cef23015f9e2268fd5ff50bf476c2109 tests: add TODO-EXTERNAL (Erik Arvstedt)
b2f7a80f9ff6dcfc1a4adb654b1be53f097b294f tests: add compatibility with 21.11 (Erik Arvstedt)
88fa33479fd9db0a66d056eab7aeefcd4ad67f21 clightning-plugins: update prometheus-client version pin (nixbitcoin)
c9c21040091c30e1f20ce0a83481be023194fc2c klein: use from upstream, update jmclient version pin (nixbitcoin)
048b49edaef0fcd8275c1076f4e5957b53203983 pyln-proto: add copy of base58 2.1.0 (nixbitcoin)
b5984a603c746050c5839ded3c5104e91a8fa0c1 joinmarket: 0.9.3 -> 0.9.4 (nixbitcoin)
84339332514559b4e83dd66f9c202fadedcd2ce7 node2nix composition: add writeShellScript (nixbitcoin)
6b725157e1d6f16403c888647d8302a3daba5ac9 clboss: sslSupport -> opensslSupport (nixbitcoin)
1a8e7d63480d635d96db70cf842384fbd2ac42aa clightning: re-enable seccomp filtering (nixbitcoin)
16f5aa0561265bb9af8dc31d4d09d32c3597ad9e update to NixOS 21.11 (nixbitcoin)
Pull request description:
ACKs for top commit:
erikarvstedt:
ACK 2f0f1ec15aa5010864584fcaf828868b56421687
jonasnick:
ACK 2f0f1ec15aa5010864584fcaf828868b56421687
Tree-SHA512: 0685f94f0bc2ab64faa8679e2b579e6f2f1e96809ff00b61083b89bd7367ac990ddc1221698ee0e6729303c2a9a120cd460f32aba4f16ac5beeada8b70b6ea5b
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
- See the examples for an overview of all features.
- To setup a new node from scratch, see the installation instructions.
- To add nix-bitcoin to an existing NixOS configuration, see importable-configuration.nix and the Flake example.
Docs
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)
- Application services
- bitcoind, with a default banlist against spy nodes
- clightning with support for announcing an onion service
Available plugins:- clboss: automated C-Lightning Node Manager
- helpme: walks you through setting up a fresh c-lightning node
- monitor: helps you analyze the health of your peers and channels
- prometheus: lightning node exporter for the prometheus timeseries server
- rebalance: keeps your channels balanced
- summary: print a nice summary of the node status
- zmq: publishes notifications via ZeroMQ to configured endpoints
- lnd with support for announcing an onion service
- Lightning Loop
- Lightning Pool
- charge-lnd: policy-based channel fee manager
- lndconnect via a REST onion service
- Ride The Lightning: web interface for
lndandclightning - spark-wallet
- electrs
- btcpayserver
- liquid
- JoinMarket
- bitcoin-core-hwi
- Helper
- netns-isolation: isolates applications on the network-level via network namespaces
- nodeinfo: script which prints info about the node's services
- backups: duplicity backups of all your node's important files
- operator: adds non-root user
operatorwho has access to client tools (e.g.bitcoin-cli,lightning-cli)
Security
- Simplicity: Only services enabled in
configuration.nixand 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.
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.