a31d07d8bf611a18247bfb85e3a47acbd60dc90a ci: update container image for modules tests (Erik Arvstedt) bc7d3a2ed7ffd7d2be25710c703eb1eda342f919 fetch-release: check that only one key is imported (Erik Arvstedt) 5ab85cb2a5df7d91b52a1ffa1dc408077bfa24ce pkgs: add `meta` attr (Erik Arvstedt) 602281b1321fbab6d9af34ad816317ff19fa14cc rtl, cl-rest: add /bin to pkg output (Erik Arvstedt) f4872f33341b4e191aaee7e713e6b77c95b5fbfb spark-wallet: use node package lockfile (Erik Arvstedt) 3091b0a4fb97512294325f5b7b35052a1985fb88 cl-rest: use node package lockfile (Erik Arvstedt) fbfb61210a699b22ea2cfff7cd64ea8786cee794 rtl: use node package lockfile (Erik Arvstedt) d296b2d1fbeef02ebac41ccd8d24171650d4fd8d charge-lnd: remove unneeded use of `literalExample` (Erik Arvstedt) f13ffe014667376faeb0a0af6c7ab711d793bb90 run-tests: make `nixosSearch` compatible with `--copy-src` (Erik Arvstedt) 2069f62abca9f42d9f72825adf38115054246ef9 krops: -> 1.26.2 (Erik Arvstedt) Pull request description: ACKs for top commit: nixbitcoin: reACK a31d07d8bf611a18247bfb85e3a47acbd60dc90a Tree-SHA512: 9fcc031b2bc8a56181fa0eae84c4809d896070bca5782f6b15a79e7d3545c77b8d436f512f709a203bcead81afe3293167dd8757635d6aeb5e5c320f106b6a83
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
lnd
andclightning
- 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
operator
who has access to client tools (e.g.bitcoin-cli
,lightning-cli
)
Security
- 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.
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.