282c45b746
cea69b73d279a3ab4506fc972045a4398d66ac97 nodeinfo: enable required option `nix-bitcoin.operator` (Erik Arvstedt)
27d95fda85f80a733aef23c2b3422af5911275f1 nodeinfo/lnd: add `onion_rest_address` (Erik Arvstedt)
54a21874ae460b2eae0515a0d1524751168201a6 nodeinfo/lnd: add `rest_address` (Erik Arvstedt)
a4bfefd562782191b1af81ce13cba19b6fdd37a1 add `presets/wireguard.nix` (Erik Arvstedt)
477e1709fbb60e3036cf655bef4fb655da8f1bca lndconnect: update to Zeus 0.7.1 (Erik Arvstedt)
f996ef37d95016998f5c3a7a73d20be3fae45620 lnd, clightning-rest: remove `lndconnectOnion`, add generic option `lndconnect` (Erik Arvstedt)
b4bc621b8cd19094c3c3e7382dde6f3b8e254024 rename `lndconnect-onion.nix` -> `lndconnect.nix` (Erik Arvstedt)
907cfe4f4cf01450debb36b7878c743d7c495d73 docs/services: improve title, fix numbering (Erik Arvstedt)
Pull request description:
ACKs for top commit:
jonasnick:
ACK cea69b73d279a3ab4506fc972045a4398d66ac97
Tree-SHA512: 747d95b49f5c1b63dfaa2c6bc302fb102e3788c36e279cc28266ea230e8daae54973d8bdb51f2a81e7e84eb86b6b1e504fbe8af85c2318525c54d901678b3f55
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
Hint: To show a table of contents, click the button (
) in the
top left corner of the documents.
- NixOS options search
- Hardware requirements
- Installation
- Configuration and maintenance
- Using services
- FAQ
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
- clightning with support for announcing an onion service
and database replication.
Available plugins:- clboss: automated C-Lightning Node Manager
- currencyrate: currency converter
- 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
- clightning-rest: REST server for clightning
- lnd with support for announcing an onion service and static channel backups
- Lightning Loop
- Lightning Pool
- charge-lnd: policy-based channel fee manager
- lndconnect: connect your wallet to lnd or clightning via WireGuard or Tor
- Ride The Lightning: web interface for
lndandclightning - spark-wallet
- electrs: Electrum server
- fulcrum: Electrum server (see the module for a comparison with electrs)
- btcpayserver
- liquid: federated sidechain
- 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: configures a non-root user who has access to client tools (e.g.
bitcoin-cli,lightning-cli)
Extension modules
Extension modules are maintained in separate repositories and have their own review and release process.
- Mempool: Bitcoin visualizer, explorer and API service
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.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.
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.
Developing
See dev/README.
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.