747019a9e9
def64a73b8d87a1c6cb261508b53c9477d3b049f treewide: use TODO-EXTERNAL (Erik Arvstedt)
6f37bef2a359ee7f3926e3a253711cb2f04ff95f netns-isolation: simplify firewall setup (Erik Arvstedt)
f52059ce3c3729fd68245d6781e7c4f13ffd0a6b docs: add doc 'Configuration and maintenance' (Erik Arvstedt)
94aee8174d291a7f1265834c8e515a64451841eb usage.md: add section `Managing services` (Erik Arvstedt)
8cc7b83da1077f68f7323a26717212b506f45ef9 usage.md: convert to '#' heading syntax (Erik Arvstedt)
91fbcfcc776db3201ee30869f9dded59931786a7 faq.md: reformat (Erik Arvstedt)
9e4f4d6b0f9fd57ee893adb754e76501c98d36fc bitcoind: add option `txindex` (Erik Arvstedt)
10a744a59845e59c7a31ac4fd922368110728047 rtl: add option `extraCurrency` (Erik Arvstedt)
62a2602e7832e01b668090d5f3df1d9b2c231d11 electrs: use dataDir for storing extra config (Erik Arvstedt)
9bda7305fd270765734b7a08f3a45dd8debe1650 services: add `tor.*` options (Erik Arvstedt)
ff24e73ad7491cb5b26ae1492ada803f6960992b onion-addresses: fix files not being copied (Erik Arvstedt)
c6fe017aeb8acde5b14ab91c4f76cc1f5ed9fdd3 netns-isolation: avoid creating service files for disabled services (Erik Arvstedt)
017e08ca10d44d3e08b11de3c6c5613c89c5999c btcpayserver: move nbxplorer options to bottom (Erik Arvstedt)
e1d869d76c40c5d981b302a1df102891e4e2560c modules.nix: move rtl to fix topological sorting (Erik Arvstedt)
e44cd7ecdc7ae72cf7256d01bdf4efbf9d06f417 rtl: improve descriptions (Erik Arvstedt)
bd275d3a9ad45d950e157821d4345d2d37257c08 minor improvements (Erik Arvstedt)
8aa28da110123c1d5de9dad343615dace8cb4337 remove `recurring-donations` module (Erik Arvstedt)
Pull request description:
ACKs for top commit:
nixbitcoin:
ACK def64a73b8d87a1c6cb261508b53c9477d3b049f
jonasnick:
ACK def64a73b8d87a1c6cb261508b53c9477d3b049f
Tree-SHA512: 13acd2a3dd73c07f9c31874c8e961f12f39accb48847cbad08479b9a8154b79a6f186819272072dfb5c4768264b81f6e058e9afa57a729db2096784e48352dfd
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.